Skip to content

Commit 017ceff

Browse files
committed
minor tweaks to CONTRIBUTING
1 parent e69e785 commit 017ceff

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ If you are reporting a bug, please include:
6666
installed libraries and pytest version.
6767
* Detailed steps to reproduce the bug.
6868

69+
If you can write a demonstration test that currently fails but should pass (xfail),
70+
that is a very useful commit to make as well, even if you can't find how
71+
to fix the bug yet.
72+
6973
.. _submitfeedback:
7074

7175
Submit feedback for developers
@@ -93,6 +97,8 @@ https://github.com/pytest-dev/pytest/labels/bug
9397

9498
:ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
9599

100+
Don't forget to check the issue trackers of your favourite plugins, too!
101+
96102
.. _writeplugins:
97103

98104
Implement features
@@ -111,10 +117,14 @@ Write documentation
111117
pytest could always use more documentation. What exactly is needed?
112118

113119
* More complementary documentation. Have you perhaps found something unclear?
114-
* Documentation translations. We currently have English and Japanese versions.
120+
* Documentation translations. We currently have only English.
115121
* Docstrings. There's never too much of them.
116122
* Blog posts, articles and such -- they're all very appreciated.
117123

124+
You can also edit documentation files directly in the Github web interface
125+
without needing to make a fork and local copy. This can be convenient for
126+
small fixes.
127+
118128
.. _`pull requests`:
119129
.. _pull-requests:
120130

0 commit comments

Comments
 (0)