Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
shenli opened this issue Aug 20, 2021 · 4 comments
Open

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

shenli opened this issue Aug 20, 2021 · 4 comments

Comments

@shenli
Copy link
Member

shenli commented Aug 20, 2021

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.

@tisonkun
Copy link
Contributor

tisonkun commented Aug 20, 2021

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

@sunxiaoguang
Copy link
Collaborator

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.

@zz-jason
Copy link
Member

zz-jason commented Aug 31, 2021

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.

@sunxiaoguang
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants