Skip to content

Latest commit

 

History

History
177 lines (103 loc) · 5.81 KB

CONTRIBUTING.rst

File metadata and controls

177 lines (103 loc) · 5.81 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/Ouranosinc/cookiecutter-pypackage/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 the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

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 Documentation

Cookiecutter PyPackage could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/Ouranosinc/cookiecutter-pypackage/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up cookiecutter-pypackage for local development. Please note this documentation assumes you already have virtualenv and Git installed and ready to go.

  1. Fork the cookiecutter-pypackage repo on GitHub.

  2. Clone your fork locally:

    cd path_for_the_repo
git clone [email protected]:YOUR_NAME/cookiecutter-pypackage.git

  3. Assuming you have virtualenv installed (If you have Python 3.8+ this should already be there), you can create a new environment for your local development by typing:

    virtualenv cookiecutter-pypackage-env
source cookiecutter-pypackage-env/bin/activate

    This should change the shell to look something like:

    (cookiecutter-pypackage-env) $

  4. Create a branch for local development:

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

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass flake8. Since, this package contains mostly templates the flake should be run for tests directory:

    flake8 ./tests

  6. The next step would be to run the test cases. cookiecutter-pypackage testing uses the pytest framework. Before you run pytest you should ensure all dependencies are installed:

    pip install -r requirements_dev.txt
pytest ./tests

    If you get any errors while installing cryptography package (something like #include <openssl/aes.h>). Please update your pip version and try again:

    # Update pip
pip install --upgrade pip

  7. Before raising a pull request you should also run tox. This will run the tests across different versions of Python:

    tox

    If you are missing flake8, pytest and/or tox, just pip install them into your virtualenv.

  8. If your contribution is a bug fix or new feature, you may want to add a test to the existing test suite. See section Add a New Test below for details.

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

  10. 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. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.8 up to Python 3.13, and for PyPy 3.11 and PyPy 3.12. Check https://github.com/Ouranosinc/cookiecutter-pypackage/actions/workflows/main.yml and make sure that the tests pass for all supported Python versions.

Add a New Test

When fixing a bug or adding features, it's good practice to add a test to demonstrate your fix or new feature behaves as expected. These tests should focus on one tiny bit of functionality and prove changes are correct.

To write and run your new test, follow these steps:

  1. Add the new test to tests/test_bake_project.py. Focus your test on the specific bug or a small part of the new feature.

  2. If you have already made changes to the code, stash your changes and confirm all your changes were stashed:

    git stash
git stash list

  3. Run your test and confirm that your test fails. If your test does not fail, rewrite the test until it fails on the original code:

    pytest ./tests

  4. (Optional) Run the tests with tox to ensure that the code changes work with different Python versions:

    tox

  5. Proceed work on your bug fix or new feature or restore your changes. To restore your stashed changes and confirm their restoration:

    git stash pop
git stash list

  6. Rerun your test and confirm that your test passes. If it passes, congratulations!