Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.21 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways.

Types of contributions

Fix bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Report bugs and issues

Report bugs by opening an issue at the relevant repository.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Implement features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write or improve documentation

The project could always use more documentation (docstrings, wiki, code comments, README, etc.). Feel free to file an issue and/or start a pull request with your changes.

Questions, feedback, and support

If you have a question, would like to provide feedback, or require support, please use the Discussions feature of the relevant repository. See the Support Guidelines for more information.

Get started

Ready to contribute? Here's how to set up a repository for local development.

  1. Fork the repository on GitHub.

  2. Clone your fork locally:

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  5. Submit a pull request through the GitHub website.

Pull request guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests (if applicable).
  2. If the pull request adds functionality, the documentation should be updated. If you added a new Python function, include a docstring with the function, and add the feature to the list in README.md.
  3. Make sure that the tests pass for all supported Python versions (if applicable).