forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Improve guides for contributing (grafana#19575)
* Move style guides into contribute directory * Move contribution guides into contribute directory * Refactor CONTRIBUTING.md * Clean up docs/README.md * Update reference to style guide and minor formatting fixes * Apply suggestions from code review Co-Authored-By: gotjosh <josue.abreu@gmail.com> * Update CONTRIBUTING.md Co-Authored-By: gotjosh <josue.abreu@gmail.com>
- Loading branch information
1 parent
27ddd2d
commit 2fb301c
Showing
14 changed files
with
189 additions
and
147 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,60 @@ | ||
| # Contributing | ||
| # Contributing to Grafana | ||
|
|
||
| Grafana uses GitHub to manage contributions. Contributions take the form of pull requests that will be reviewed by the core team. | ||
| Thank you for your interest in contributing to Grafana! We welcome all people who want to contribute in a healthy and constructive manner within our community. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| - If you are a new contributor, see [Steps to contribute](#steps-to-contribute). | ||
| This document is a guide to help you through the process of contributing to Grafana. | ||
|
|
||
| - If you have a trivial fix or improvement, go ahead and create a pull request. | ||
| ## Become a contributor | ||
|
|
||
| - 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. | ||
| You can contribute to Grafana in several ways. Here are some examples: | ||
|
|
||
| - Sign our [CLA](http://docs.grafana.org/contribute/cla/). | ||
| - Contribute to the Grafana codebase. | ||
| - Report and triage bugs. | ||
| - Develop community plugins and dashboards. | ||
| - Write technical documentation and blog posts, for users and contributors. | ||
| - Organize meetups and user groups in your local area. | ||
| - Help others by answering questions about Grafana. | ||
|
|
||
| - Follow the code style guides: | ||
| - [Backend style guide](https://github.com/grafana/grafana/tree/master/pkg) | ||
| - [Frontend style guide](https://github.com/grafana/grafana/tree/master/style_guides) | ||
| For more ways to contribute, check out the [Open Source Guides](https://opensource.guide/how-to-contribute/). | ||
|
|
||
| ## Steps to contribute | ||
| ### Report bugs | ||
|
|
||
| Should you wish to work on a GitHub issue, check first if it is not already assigned to someone. If it is free, you claim it by commenting on the issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue. | ||
| Report a bug by submitting a [bug report](https://github.com/grafana/grafana/issues/new?labels=type%3A+bug&template=1-bug_report.md). Make sure that you provide as much information as possible on how to reproduce the bug. | ||
|
|
||
| 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. | ||
| Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/grafana/grafana/issues) for similar issues. | ||
|
|
||
| To set up a local development environment we recommend reading [Building Grafana from source](http://docs.grafana.org/project/building_from_source/). | ||
| #### Security issues | ||
|
|
||
| ## Pull request checklist | ||
| If you believe you've found a security vulnerability, please read our [security policy](https://github.com/grafana/grafana/security/policy) for more details. | ||
|
|
||
| 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. | ||
| ### Suggest enhancements | ||
|
|
||
| - 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 you have an idea of how to improve Grafana, submit an [enhancement request](https://github.com/grafana/grafana/issues/new?labels=type%3A+feature+request&template=2-feature_request.md). | ||
|
|
||
| - 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. | ||
| ### Your first contribution | ||
|
|
||
| - Add tests relevant to the fixed bug or new feature. | ||
| Unsure where to begin contributing to Grafana? Start by browsing issues labeled `beginner friendly` or `help wanted`. | ||
|
|
||
| ### High-level checks | ||
| - [Beginner-friendly](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete. | ||
| - [Help wanted](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity. | ||
|
|
||
| - [ ] 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 closes one issue if possible and does not fix unrelated issues within the same pull request. | ||
| - [ ] The pull request contains necessary tests. | ||
| If you're looking to make a code change, see how to set up your environment for [local development](contribute/development.md). | ||
|
|
||
| ### Low-level checks | ||
| When you're ready to contribute, it's time to [Create a pull request](/contribute/pull-request.md). | ||
|
|
||
| - [ ] The pull request contains a title that explains it. It follows [PR and commit messages guidelines](#Pull-Requests-titles-and-message). | ||
| - [ ] The pull request contains necessary links to issues. | ||
| - [ ] The pull request contains commits with messages that are small and understandable. It follows [PR and commit messages guidelines](#Pull-Requests-titles-and-message). | ||
| - [ ] The pull request does not contain magic strings or numbers that could be replaced with an `Enum` or `const` instead. | ||
| #### Contributor License Agreement (CLA) | ||
|
|
||
| #### Bug-specific checks | ||
| Before we can accept your pull request, you need to [sign our CLA](https://grafana.com/docs/contribute/cla/). If you haven't, our CLA assistant prompts you to when you create your pull request. | ||
|
|
||
| - [ ] The pull request contains `Closes: #Issue` or `Fixes: #Issue` in pull request description. | ||
| - [ ] The Pull Request adds tests that replicate the fixed bug and helps avoid regressions. | ||
| ## Community | ||
|
|
||
| ### Frontend-specific checks | ||
| - Follow [@grafana on Twitter](https://twitter.com/grafana/) | ||
| - Read and subscribe to the [Grafana blog](https://grafana.com/blog/) | ||
| - If you have a specific question, check out our [discussion forums](https://community.grafana.com). | ||
| - For general discussions, join us on the [official Slack](http://slack.raintank.io/). | ||
|
|
||
| - [ ] The pull request does not increase the Angular code base. | ||
| > We are in the process of migrating to React so any increment of Angular code is generally discouraged. | ||
| - [ ] The pull request does not contain uses of `any` or `{}` without comments describing why. | ||
| - [ ] The pull request does not contain large React components that could easily be split into several smaller components. | ||
| - [ ] The pull request does not contain back end calls directly from components, use actions and Redux instead. | ||
| - [ ] The pull request follows our [styling with Emotion convention](./style_guides/styling.md) | ||
| > We still use a lot of SASS, but any new CSS work should be using or migrating existing code to Emotion | ||
| ## Where do I go from here? | ||
|
|
||
| #### Redux specific checks (skip if your pull request does not contain Redux changes) | ||
|
|
||
| - [ ] The pull request does not contain code that mutates state in reducers or thunks. | ||
| - [ ] The pull request uses helpers `actionCreatorFactory` and `reducerFactory` instead of traditional `switch statement` reducers in Redux. See [Redux framework](https://github.com/grafana/grafana/tree/master/style_guides/redux.md) for more details. | ||
| - [ ] The pull request uses `reducerTester` to test reducers. See [Redux framework](https://github.com/grafana/grafana/tree/master/style_guides/redux.md) for more details. | ||
| - [ ] The pull request does not contain code that accesses the reducers state slice directly, instead, the code uses state selectors to access state. | ||
|
|
||
| ### Pull request titles and message | ||
|
|
||
| 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. | ||
|
|
||
| Good examples: | ||
|
|
||
| - `Explore: Adds Live option for supported data sources` | ||
| - `GraphPanel: Don't sort series when legend table & sort column is not visible` | ||
| - `Build: Support publishing MSI to grafana.com` | ||
|
|
||
| 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 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. | ||
| 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 Git commit title should be short, descriptive and include the Pull Request ID. | ||
|
|
||
| Good examples: | ||
|
|
||
| - `Explore: Live supprt in data sources (#12345)` | ||
| - `GraphPanel: Fix legend sorting issues (#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. | ||
| - Set up your [development environment](contribute/development.md). | ||
| - Learn how to [contribute documentation](contribute/documentation.md). | ||
| - Get started [developing plugins](https://grafana.com/docs/plugins/developing/development/) for Grafana. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.