Contributions are highly welcomed and appreciated. Every little help counts, so do not hesitate!
Contribution links
Pytest development of the core, some plugins and support code happens in repositories living under:
All pytest-dev team members have write access to all contained repositories. pytest core and plugins are generally developed using pull requests to respective repositories.
You can submit your plugin by subscribing to the pytest-dev mail list and writing a mail pointing to your existing pytest plugin repository which must have the following:
If no contributor strongly objects and two agree, the repo will be transferred to the pytest-dev organisation and you’ll become a member of the pytest-dev team, with commit rights to all projects. We recommend that each plugin has at least three people who have the right to release to pypi.
Report bugs for pytest at https://github.com/pytest-dev/pytest/issues
If you are reporting a bug, please include:
Do you like pytest? Share some love on Twitter or in your blog posts!
We’d also like to hear about your propositions and suggestions. Feel free to submit them as issues and:
Look through the GitHub issues for bugs. Here is sample filter you can use: https://github.com/pytest-dev/pytest/labels/bug
Talk to developers to find out how you can fix specific bugs.
Look through the GitHub issues for enhancements. Here is sample filter you can use: https://github.com/pytest-dev/pytest/labels/enhancement
Talk to developers to find out how you can implement specific features.
pytest could always use more documentation. What exactly is needed?
Note
What is a “pull request”? It informs project’s core developers about the changes you want to review and merge. Pull requests are stored on GitHub servers. Once you send pull request, we can discuss it’s potential modifications and even add more commits to it later on.
There’s an excellent tutorial on how Pull Requests work in the GitHub Help Center, but here is a simple overview:
Fork the pytest GitHub repository. It’s fine to use pytest as your fork repository name because it will live under your user.
Clone your fork locally using git and create a branch:
$ git clone git@github.com:YOUR_GITHUB_USERNAME/pytest.git
$ cd pytest
$ git checkout pytest-2.7 # if you want to fix a bug for the pytest-2.7 series
$ git checkout master # if you want to add a feature bound for the next minor release
$ git branch your-branch-name # your feature/bugfix branch
If you need some help with Git, follow this quick start guide: https://git.wiki.kernel.org/index.php/QuickStart
Create a development environment (will implicitly use http://www.virtualenv.org/en/latest/):
$ make develop
$ source .env/bin/activate
You can now edit your local working copy.
You need to have Python 2.7 and 3.4 available in your system. Now running tests is as simple as issuing this command:
$ python runtox.py -e py27,py34,flakes
This command will run tests via the “tox” tool against Python 2.7 and 3.4 and also perform “flakes” coding-style checks. runtox.py is a thin wrapper around tox which installs from a development package index where newer (not yet released to pypi) versions of dependencies (especially py) might be present.
To run tests on py27 and pass options (e.g. enter pdb on failure) to pytest you can do:
$ python runtox.py -e py27 -- --pdb
or to only run tests in a particular test module on py34:
$ python runtox.py -e py34 -- testing/test_config.py
Commit and push once your tests pass and you are happy with your change(s):
$ git commit -a -m "<commit message>"
$ git push -u
Finally, submit a pull request through the GitHub website:
head-fork: YOUR_GITHUB_USERNAME/pytest
compare: your-branch-name
base-fork: pytest-dev/pytest
base: master # if it's a feature
base: pytest-VERSION # if it's a bugfix