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 using GitHub Issues.

If you are reporting a bug, please include:

  • 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” is open to whoever wants to implement it.

Write Documentation

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

Documentation is built automatically on every push to master using GitHub Actions.

Submit Feedback

The best way to send feedback is to file an issue using GitHub Issues.

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.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

After checking out the project, running make at any time will clean up and set up a fresh dev environment. Read the Makefile for more common tasks/recipes.

Ready to contribute? Here’s how to set up collections-extended for local development.

  1. Fork the collections-extended repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/collections-extended.git
  3. Make sure you are excluding your editor’s files from the repo.

    We don’t want to use the project’s gitignore to exclude every editor’s files, so set up your global gitignore. See: https://help.github.com/articles/ignoring-files/

  4. Set up your local dev environment:

    $ cd collections-extended
$ make

  5. Create a branch for local development:

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

  6. Make your changes locally.

  7. You may run checks locally without having to create a PR:

    $ make lint
$ make tests
$ make testall
$ make coverage

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

    $ git add .
$ git commit
$ git push origin name-of-your-bugfix-or-feature

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

  3. The pull request should work for all supported versions. Check https://github.com/mlenzen/collections-extended/actions and make sure that the tests pass for all supported Python versions.

  4. Add the feature/bug to the appropriate section in HISTORY.rst

Tips

To run a subset of tests:

$ py.test tests/test_example.py
$ py.test tests/test_example.py::test_func