Skip to content

Commit 75ba0bc

Browse files
authoredApr 20, 2017
Add some hints about testing to CONTRIBUTING.rst
1 parent b37e435 commit 75ba0bc

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed
 

‎CONTRIBUTING.rst

+12-4
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,20 @@ Here are some guidelines about how you can contribute to Nikola:
5656
and `added to GitHub <https://github.com/settings/emails>`_
5757
* **Try writing some tests** if possible — again, following existing tests is
5858
often easiest, and a good way to tell whether the feature you are modifying is
59-
easily testable. You will find instructions in ``tests/README.rst``.
60-
(alternatively you can push and wait for Travis to pick up and test your changes,
61-
but we encourage to run them locally before pushing.)
59+
easily testable.
60+
* **Test your code.** If you can, run the test suite. You will find instructions
61+
in ``tests/README.rst``. (alternatively, you can push and wait for Travis to pick
62+
up and test your changes)
63+
64+
If running tests is not feasible, please at least confirm that:
65+
66+
* the demo site (created with ``nikola init -qd demosite``) builds without errors
67+
* the bugs you were trying to fix do not occur anymore (if applicable)
68+
* the features you added work properly (if applicable)
69+
6270
* There are some quirks to how Nikola’s codebase is structured, and to how
6371
some things need to be done [2]_ but don’t worry, we’ll guide you!
6472

6573
.. [1] Very inspired by `fabric’s <https://github.com/fabric/fabric/blob/master/CONTRIBUTING.rst>`_ — thanks!
6674
67-
.. [2] For example, logging, or always making sure directories are created using ``utils.makedirs()``
75+
.. [2] For example, logging or always making sure directories are created using ``utils.makedirs()``.

0 commit comments

Comments
 (0)
Please sign in to comment.