Skip to content

Latest commit

 

History

History
119 lines (79 loc) · 3.09 KB

CONTRIBUTING.rst

File metadata and controls

119 lines (79 loc) · 3.09 KB

Contribution

Getting started

What open source project doesn't like getting contributions? Don't hesitate to send us feature requests, bug reports, bug fixes, or pull requests.

Contribution links

Feature Requests

We are happy to consider new features, but be aware that we feel libraries are best when small and focused so not everything will be considered. Submit them as issues and:

  • Explain in detail why this feature is necessary/useful
  • Step through exactly how it should work. The more detail the better.

Report bugs

Reporting bugs is one of the most valuable things you can do, when done properly.

Report all bugs for pyzu in the issue tracker.

Please include the following in any bug report:

  • Your operating system name and version.
  • The version of Python you are using, as well as any other useful information about your environment (library version, etc).
  • Any relevant tracebacks.
  • Detailed steps to reproduce the bug.

If you can write a test that currently fails but should pass, that is an extremely valuable contribution, even if you cannot fix the bug itself.

Fixing bugs

Look through the GitHub issues for bugs.

A good bug fix will include:

  • Tests to ensure the bug is fixed and stays fixed.
  • A link to the appropriate issue in the pull request.

Preparing Pull Requests

  1. Fork the repository

  2. Clone the repository from your account into your local file system:

    git clone [email protected]:<username>/pyzu.git

  3. Setup your upstream origin, and make sure your forked code has the latest code:

    git remote add upstream https://github.com/chason/pyzu.git
git fetch upstream
git checkout master
git merge upstream/master

  4. Create new branch:

    git checkout -b my_awesome_feature

  5. Write new code following the :ref:`codestyle`

  6. Run tests:

    pytest

  7. Commit your code, mentioning the issue number in the description:

    git add *
git commit -m "Fixing issue #1"

  8. Push the code to your origin:

    git push origin

  9. Point your web browser to the Github page for the project and click on the New pull request button. GitHub documentation

  10. Pat yourself on the back for a job well done!

Code Style Guidelines

To create a consistent code style across the codebase its important to follow a few rules.

All new code should meet the following guidelines:

  • PEP-8 for the most part, except for line length (set at 88).
  • Use black for formatting.
  • Use type hinting everywhere.
  • Public methods should have a docstring that describes their use, parameters, and output.
  • 100% test code coverage