tidb-dev-guide icon indicating copy to clipboard operation
tidb-dev-guide copied to clipboard

Is it better to rename it to tidb-contributor-guide

Open shenli opened this issue 4 years ago • 4 comments

I think "contributor" is a better name. Since “developer” is a little bit ambiguous, app developer and database developer. For other database companies, they only consider developer as app developer.

shenli avatar Aug 20 '21 02:08 shenli

@sunxiaoguang @zz-jason what do you think? My concern is about links we share outside, but basically this guide is in the bootstrap stage.

tisonkun avatar Aug 20 '21 15:08 tisonkun

The book title is TiDB Development Guide, it just happens to have a short spelling that people may think of it as TiDB Developer Guide.

However even if that's the case, I found people use devguide for different purposes. For example, Python community has Python Developer’s Guide for contributors.

I don't have a strong preference over this, either way is fine for me. We can always use redirection to help people with existing link to updated name to make the migration smooth for readers.

sunxiaoguang avatar Aug 20 '21 15:08 sunxiaoguang

The word "developer" can have different meanings in different contexts. Seems in the context of "developer guide", it means community contributor who "develops" the TiDB open-source project. For example:

Python Developer's Guide:

This guide is a comprehensive resource for contributing to Python – for both new and experienced contributors. It is maintained by the same community that maintains Python. We welcome your contributions to Python!

Guide to Rustc Development

This guide is meant to help document how rustc – the Rust compiler – works, as well as to help new contributors get involved in rustc development.

It's OK for me to change the "TiDB Development Guide" to "TiDB Contribution Guide", both LGTM.

zz-jason avatar Aug 31 '21 15:08 zz-jason

It's OK for me to change the "TiDB Development Guide" to "TiDB Contribution Guide", both LGTM.

Actually, the current title is TiDB Development Guide. From my opinion it's ok to remain it unchanged.

sunxiaoguang avatar Aug 31 '21 15:08 sunxiaoguang