docs(standards): add commit style guide #680
Conversation
| - Push your changes to a topic branch in your fork of the repository. | ||
| - Submit a pull request | ||
|
|
||
| Thanks for you contributions! |
There was a problem hiding this comment.
This was mostly a direct copypasta of Fleet's CONTRIBUTING.md. I'll send a typo fix upstream as well then :)
this introduces a new commit standard for Deis developers. The goal of this commit is to allow developers to search through the history better, provide us better information through commit messages, and eventually allowing us to script the CHANGELOG.md so that we do not have to rely on a third-party tool to do the parsing for us.
some of the documentation's listed commands are outdated and need to be updated to reflect the new workflow changes.
Some of the sentences in the documentation is poorly written.
|
LGTM. |
|
I say that we shouldn't enforce this until the next release, so that any old PRs can be merged without worry. After that, they should follow the new standard. |
|
Yes, that would be more polite. But I think we can go ahead and merge this into the docs now, right? |
|
I think so. It might be nice to add a note in the release notes about this PR so that we have something to reference in the future. |
|
LGTM. Wondering if should rename deis-cookbook/CONTRIBUTING.md to TESTING.md and adopt most of this as the contributing agreement (save the string enforcement of commit formatting). |
|
Hmm. Maybe a link to this document may be better, as the cookbook is a branch of the Deis project, and it is maintained by OpDemand. cc @gabrtv |
docs(standards): add commit style guide
this introduces a new commit standard for Deis developers. The goal of this commit is to allow developers to search through the history better, provide us better information through commit messages, and eventually allowing us to script the CHANGELOG.md so that we do not have to rely on a third-party tool to do the parsing for us.