Commit 6d6c7698 by Torkel Ödegaard Committed by GitHub

Merge pull request #15881 from zhulongcheng/docs-Contributing

docs: update CONTRIBUTING.md
parents 57018738 e08d8eb5
...@@ -34,10 +34,10 @@ To setup a local development environment we recommend reading [Building Grafana ...@@ -34,10 +34,10 @@ To setup a local development environment we recommend reading [Building Grafana
### Pull requests with new features ### Pull requests with new features
Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
Make sure to include `closes #<issue>` or `fixes #<issue>` in the pull request description. Make sure to include `Closes #<issue number>` or `Fixes #<issue number>` in the pull request description.
### Pull requests with bug fixes ### Pull requests with bug fixes
Please make all changes in one commit if possible. Include `closes #12345` in bottom of the commit message. Please make all changes in one commit if possible. Include `Closes #<issue number>` in bottom of the commit message.
A commit message for a bug fix should look something like this. A commit message for a bug fix should look something like this.
``` ```
...@@ -48,7 +48,7 @@ provsioners each provisioner overwrite each other. ...@@ -48,7 +48,7 @@ provsioners each provisioner overwrite each other.
filling up dashboard_versions quite fast if using filling up dashboard_versions quite fast if using
default settings. default settings.
closes #12864 Closes #12864
``` ```
If the pull request needs changes before its merged the new commits should be rebased into one commit before its merged. If the pull request needs changes before its merged the new commits should be rebased into one commit before its merged.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment