Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.74 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Ways of contributing

Contribution does not necessarily mean committing code to the repository. We recognize different levels of contributions as shown below in increasing order of dedication:

  1. Test and use the project. Give feedback on the user experience or suggest new features.
  2. Report bugs or security vulnerability
  3. Fix bugs.
  4. Improve the project with developing new features.

Filing bugs, security vulnerability or feature requests

You can file bugs against and feature requests for the project via github issues. Consult GitHub Help for more information on using github issues.

Community Guidelines

This project follows the following Code of Conduct.

Code reviews

All patches and contributions, including patches and contributions by project members, require review by one of the maintainers of the project. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Pull Request Process

Contributions should be submitted as Github pull requests. See Creating a pull request if you're unfamiliar with this concept.

The process for a code change and pull request you should follow:

  1. Create a topic branch in your local repository, following the naming format "feature-[description]". For more information see the Git branching guideline.
  2. Make changes, compile, and test thoroughly. Ensure any install or build dependencies are removed before the end of the layer when doing a build. Code style should match existing style and conventions, and changes should be focused on the topic the pull request will be addressed. For more information see the style guide.
  3. Push commits to your fork.
  4. Create a Github pull request from your topic branch.
  5. Pull requests will be reviewed by one of the maintainers who may discuss, offer constructive feedback, request changes, or approve the work. For more information see the Code review guideline.
  6. Upon receiving the sign-off of one of the maintainers you may merge your changes, or if you do not have permission to do that, you may request a maintainer to merge it for you.

Attribution

This Contributing.md is adapted from Google available at https://github.com/google/new-project/blob/master/docs/contributing.md