Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

25 lines (20 loc) · 1.78 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to our project! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct. When contributing to this repository, please first discuss the change you wish to make via a GitHub issue. with the owners of this repository listed on the README.md before making a change. Please follow these guidelines when contributing to this project.

How to submit changes: Pull Request Process

  1. Create a branch where you will be working on your changes, and name it appropriately (e.g. feature/feature-name or bugfix/bug-name).
  2. Make sure you are able to run the code locally, and that all the sanity checks pass.
  3. Ensure that any new code is properly documented and tested.
  4. Ensure that any new code is properly formatted
  5. Ensure any temporary files are removed before committing, and that the .gitignore file is updated to ignore any new temporary files, that you may have created.
  6. After you have committed your changes to your repostiory, create a pull request to the main branch of the original repository. A pull request will be looked at by the maintainers of the repository, and if it is approved, it will be merged into the main branch within 10 days.

Note that the main branch is protected, and requires at least one review before merging. Please ensure that you have at least one reviewer assigned to your pull request.

How to report an issue

  1. Create a GitHub issue, and label it appropriately.
    1. bug
    2. documentation issue
    3. enhancement
    4. question
  2. Assign the issue to one of the maintainers listed on the README.md, if you had a discussion with them about the issue, otherwise leave it unassigned.