Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 2.4 KB

Contributing

Code of Conduct

Creating a welcoming and inclusive environment is important to the creation of a healthy open source project. To that end, all contributions are bound by the code of conduct in this repository.

Above all, please be kind and courteous.

In addition, please keep in mind that the maintainer(s) of this repository may have families, jobs, hobbies, or other responsibilities and responses might be slow. Please be patient.

Contributing with Issues and Discussion

Please feel free to open, comment on, or otherwise be involved with issues in this repository. All bug reports, feature suggestions, user input, debugging, and more are more than welcome.

Contribution with code

Terms of Contributed Code

Please note that by both industry convention and GitHub policy, your code is contributed in the same LICENSE as the rest of the repository.

How to Contribute Code

If you would like to contribute code to this repository, please use the following method:

  1. Search for a relevant issue first to ensure you are not duplicate work with another individual. If there is an issue for the change you would like, consider commenting there and offering to help or adding your input.
  2. If there is no relevant issue, open an issue of your own with the change you would like to make. Include details on motivation, design, user impact, and other relevant information. This gives the community a chance to discuss and give feedback early in the process.
  3. Follow the GitHub pull request process to create a branch, make your changes, and submit a pull request.
  4. Your pull request will be reviewed for code quality, consistency, and functionality by community members and repository maintainers. This process is in place to help us all improve, so please strive to give and take feedback in a positive manner.
  5. If approved, your code will be merged in to the repository and your issue may then be marked as resolved. Congratulations!

Pull requests must meet the following requirements:

  • Code must successfully build and pass all tests in the branch
  • The PR must be approved by at least one repository maintainer.