minor tweaks to CONTRIBUTING

This commit is contained in:
Brianna Laugher 2015-07-26 12:19:39 +02:00
parent e69e785b23
commit 017ceffb76
1 changed files with 11 additions and 1 deletions

View File

@ -66,6 +66,10 @@ If you are reporting a bug, please include:
installed libraries and pytest version. installed libraries and pytest version.
* Detailed steps to reproduce the bug. * Detailed steps to reproduce the bug.
If you can write a demonstration test that currently fails but should pass (xfail),
that is a very useful commit to make as well, even if you can't find how
to fix the bug yet.
.. _submitfeedback: .. _submitfeedback:
Submit feedback for developers Submit feedback for developers
@ -93,6 +97,8 @@ https://github.com/pytest-dev/pytest/labels/bug
:ref:`Talk <contact>` to developers to find out how you can fix specific bugs. :ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
Don't forget to check the issue trackers of your favourite plugins, too!
.. _writeplugins: .. _writeplugins:
Implement features Implement features
@ -111,10 +117,14 @@ Write documentation
pytest could always use more documentation. What exactly is needed? pytest could always use more documentation. What exactly is needed?
* More complementary documentation. Have you perhaps found something unclear? * More complementary documentation. Have you perhaps found something unclear?
* Documentation translations. We currently have English and Japanese versions. * Documentation translations. We currently have only English.
* Docstrings. There's never too much of them. * Docstrings. There's never too much of them.
* Blog posts, articles and such -- they're all very appreciated. * Blog posts, articles and such -- they're all very appreciated.
You can also edit documentation files directly in the Github web interface
without needing to make a fork and local copy. This can be convenient for
small fixes.
.. _`pull requests`: .. _`pull requests`:
.. _pull-requests: .. _pull-requests: