Skip to content

Latest commit

 

History

History
98 lines (61 loc) · 2.68 KB

CONTRIBUTING.rst

File metadata and controls

98 lines (61 loc) · 2.68 KB
Raw

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

Report Bugs

Report bugs at https://github.com/badpacketsllc/bpq/issues.

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.

Fix Bugs

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

Implement Features

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

Write Documentation

The project could always use more documentation, whether as part of the official docs, wiki or source code in the GitHub project.

Submit Feedback

The best way to send feedback is to file an issue on the project issue tracker.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started!

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

  1. Set up a Python environment. bpq requires only Python version 3.6 or higher. Pull requests for supporting older version of Python will be considered, but Python 3.3 or lower will never be supported.

  2. Fork the repo on GitHub

  3. Clone the repo locally:

    $ git clone [email protected]:your_username_here/bpq.git

  4. Create a branch for local development:

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

    Now you can make your changes locally.

  5. 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

  6. 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.
  2. If the pull request adds functionality, the docs should be updated. Document your new feature using language-native documentation, and add the feature to the list in README.md.
  3. If it creates a new release, add the changes to HISTORY.rst.
  4. If you are a new contributor, add yourself to AUTHORS.rst.