@@ -56,12 +56,20 @@ Here are some guidelines about how you can contribute to Nikola:
56
56
and `added to GitHub <https://github.com/settings/emails >`_
57
57
* **Try writing some tests ** if possible — again, following existing tests is
58
58
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
+
62
70
* There are some quirks to how Nikola’s codebase is structured, and to how
63
71
some things need to be done [2 ]_ but don’t worry, we’ll guide you!
64
72
65
73
.. [1 ] Very inspired by `fabric’s <https://github.com/fabric/fabric/blob/master/CONTRIBUTING.rst >`_ — thanks!
66
74
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