Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.23 KB
Raw

Contributing

Thank you so much to consider contributing to this project!

When contributing to this repository, please first discuss the change you wish to make via issue or any other method before making a change.

I separated good first issues with the label good first issue to help you to start contributing to this project. If you want to contribute with something else, please open an issue to discuss it or search for an issue that is already open in Issues.

Getting Started

  1. Fork the repository on GitHub
  2. Clone the forked repository to your local machine
  3. Install the dependencies with pip install -r requirements.txt
  4. Start doing your changes
  5. Commit and push your changes to your forked repository
  6. Create a pull request to the original repository
  7. Wait for the pull request to be reviewed and merged
  8. Celebrate 🎉

Attention after your changes

  1. Update the README.md with details of changes to the interface.
  2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.