IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-25 18:30:41 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update CONTRIBUTING.md (#19273)

Browse Source 
Minor grammar and clarity improvements
This commit is contained in:
oddlittlebird 2019-09-22 11:15:35 -07:00 committed by Marcus Olsson
parent cb9637b21a
commit cff3e37e9e
1 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -1,19 +1,18 @@
# Contributing # Contributing
Grafana uses GitHub to manage contributions. Grafana uses GitHub to manage contributions. Contributions take the form of pull requests that will be reviewed by the core team.
Contributions take the form of pull requests that will be reviewed by the core team.
- If you are a new contributor see: [Steps to Contribute](#steps-to-contribute). - If you are a new contributor, see [Steps to contribute](#steps-to-contribute).
- If you have a trivial fix or improvement, go ahead and create a pull request. - If you have a trivial fix or improvement, go ahead and create a pull request.
- If you plan to do something more involved, discuss your idea on the respective [issue](https://github.com/grafana/grafana/issues) or create a [new issue](https://github.com/grafana/grafana/issues/new) if it does not exist. This will avoid unnecessary work and surely give you and us a good deal of inspiration. - If you plan to do something more involved, then discuss your idea on the respective [issue](https://github.com/grafana/grafana/issues) or create a [new issue](https://github.com/grafana/grafana/issues/new) if one does not exist. This helps avoid unnecessary work and gives you and us a good deal of inspiration.
- Sign our [CLA](http://docs.grafana.org/contribute/cla/). - Sign our [CLA](http://docs.grafana.org/contribute/cla/).
- Make sure to follow the code style guides: - Follow the code style guides:
- [Backend](https://github.com/grafana/grafana/tree/master/pkg) - [Backend style guide](https://github.com/grafana/grafana/tree/master/pkg)
- [Frontend](https://github.com/grafana/grafana/tree/master/style_guides) - [Frontend style guide](https://github.com/grafana/grafana/tree/master/style_guides)
## Steps to contribute ## Steps to contribute
@ -21,21 +20,21 @@ Should you wish to work on a GitHub issue, check first if it is not already assi
Please check the [`beginner friendly`](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) and [`help wanted`](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) labels to find issues that are good for getting started. If you have questions about one of the issues, with or without the tag, please comment on them and one of the core team or the original poster will clarify it. Please check the [`beginner friendly`](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) and [`help wanted`](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) labels to find issues that are good for getting started. If you have questions about one of the issues, with or without the tag, please comment on them and one of the core team or the original poster will clarify it.
To setup a local development environment we recommend reading [Building Grafana from source](http://docs.grafana.org/project/building_from_source/). To set up a local development environment we recommend reading [Building Grafana from source](http://docs.grafana.org/project/building_from_source/).
## Pull request checklist ## Pull request checklist
Whether you are contributing or doing code review, first read and understand https://google.github.io/eng-practices/review/reviewer/ for general engineering practices around code reviews that we also use. Whether you are contributing or doing code review, first read and understand https://google.github.io/eng-practices/review/reviewer/ for general engineering practices around code reviews that we also use.
- Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes. - Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master, then you might be asked to rebase your changes.
- If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment. - If your patch is not getting reviewed or you need a specific person to review it, then you can @-reply a reviewer asking for a review in the pull request or a comment.
- Add tests relevant to the fixed bug or new feature. - Add tests relevant to the fixed bug or new feature.
### High-level checks ### High-level checks
- [ ] The pull request adds value and the impact of the change is in line with [Backend](https://github.com/grafana/grafana/tree/master/pkg) or [Frontend](https://github.com/grafana/grafana/tree/master/style_guides). - [ ] The pull request adds value and the impact of the change is in line with the [Backend style guide](https://github.com/grafana/grafana/tree/master/pkg) or [Frontend style guide](https://github.com/grafana/grafana/tree/master/style_guides).
- [ ] The pull request works the way it says it should do. - [ ] The pull request works the way it says it should do.
- [ ] The pull request closes one issue if possible and does not fix unrelated issues within the same pull request. - [ ] The pull request closes one issue if possible and does not fix unrelated issues within the same pull request.
- [ ] The pull request contains necessary tests. - [ ] The pull request contains necessary tests.
@ -69,8 +68,7 @@ Whether you are contributing or doing code review, first read and understand htt
### Pull request titles and message ### Pull request titles and message
Pull request titles should follow this format: `Area: Name of the change`. Pull request titles should follow this format: `Area: Name of the change`. Titles are used to generate the changelog so they should be as descriptive as possible in one line.
Titles are used to generate the changelog so they should be as descriptive as possible in one line.
Good examples: Good examples:
@ -78,9 +76,9 @@ Good examples:
- `GraphPanel: Don't sort series when legend table & sort column is not visible` - `GraphPanel: Don't sort series when legend table & sort column is not visible`
- `Build: Support publishing MSI to grafana.com` - `Build: Support publishing MSI to grafana.com`
The message in the Pull requests should contain a reference so the issue if there is one. Ex `Closes #<issue number>`, `Fixes #<issue number>`, or `Ref #<issue number>` if the change is related to an issue but does not close it. Make sure to explain what problem the pull request is solving and why its implemented this way. As a new contributor its often better to overcommunicate to avoid back and forth communication, as it consumes time and energy. The message in the pull requests should contain a reference so the issue if there is one. For example, `Closes #<issue number>`, `Fixes #<issue number>`, or `Ref #<issue number>` if the change is related to an issue but does not close it. Make sure to explain what problem the pull request is solving and why its implemented this way. As a new contributor its often better to overcommunicate to avoid back-and-forth communication, as it consumes time and energy.
### GIT commit formating. ### Git commit formatting
Grafana Squash Pull requests when merging them into master. This means the maintainer will be responsible for the title in the git commit message. Grafana Squash Pull requests when merging them into master. This means the maintainer will be responsible for the title in the git commit message.
The commit message of the commits in the Pull Request can still be part of the git commit body. So it's always encouraged to write informative commit messages. The commit message of the commits in the Pull Request can still be part of the git commit body. So it's always encouraged to write informative commit messages.
@ -93,4 +91,4 @@ Good examples:
- `GraphPanel: Fix legend sorting issues (#12345)` - `GraphPanel: Fix legend sorting issues (#12345)`
- `Build: Support publishing MSI to grafana.com (#12345)` - `Build: Support publishing MSI to grafana.com (#12345)`
Its also good practice to include a reference to the issue in the git commit body when possible. Its also good practice to include a reference to the issue in the Git commit body when possible.