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

please add commit convention description in CONTRIBUTING.rst #9897

Closed
jeanbza opened this issue Nov 27, 2019 · 4 comments
Closed

please add commit convention description in CONTRIBUTING.rst #9897

jeanbza opened this issue Nov 27, 2019 · 4 comments
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@jeanbza
Copy link
Contributor

jeanbza commented Nov 27, 2019

CONTRIBUTING.rst has no mention of the commit convention. That makes it quite hard to create a proper commit to this repo first time around.

@IlyaFaer IlyaFaer self-assigned this Nov 27, 2019
@IlyaFaer IlyaFaer added the type: docs Improvement to the documentation for an API. label Nov 27, 2019
@IlyaFaer
Copy link

@paul1319, this is a good issue for the first task

@tswast
Copy link
Contributor

tswast commented Nov 27, 2019

I believe we are following the angular conventional commits convention.

I think this would make sense to document at https://github.com/googleapis/google-cloud-common/tree/master/contributing

@IlyaFaer
Copy link

I think this would make sense to document at https://github.com/googleapis/google-cloud-common/tree/master/contributing

I assume, it should be mentioned in both python/CONTRIBUTING.md and common/CONTRIBUTING.md, as new people are usually coming right to the concrete language repo, and they may not even suspect google-cloud-common repo exists.

Other languages, as I see, are now using this convention too, so we probably should mention it in other language specific repos, to make sure it's on a prominent place.

@tswast
Copy link
Contributor

tswast commented Dec 2, 2019

That proposal makes sense to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

4 participants