Skip to content

Commit c634ebf

Browse files
committed
doc: Add testing notes, how to help, update current year
[ci skip]
1 parent 215000a commit c634ebf

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@ feature to avoid any rejection and disappointment.
9191
One branch per bug/feature. Don't stack PR on top of other PR branches!
9292

9393

94+
### Testing
95+
96+
Testing can be done by using [Nose](http://nose.readthedocs.io/).
97+
As described in Nose documentation, run `nosetests3` in the top
98+
level of the project directory.
99+
100+
Additionally, the project is [configured to use the free Travis CI]
101+
(https://travis-ci.org/chfoo/wpull).
102+
103+
94104
### Making the PR
95105

96106
When you file a pull request, a template will appear reminding you
@@ -101,3 +111,10 @@ of this document. It will also remind you to:
101111
* Describe *what* you changed and *why* you changed them.
102112
* Set GitHub merge options to merge into `develop` if you branch
103113
from `develop`.
114+
115+
GitHub will also run tests on the code. If there is an error,
116+
please take a look at to see if it is related to your PR.
117+
See Testing above. Sometimes the build is broken and may not be
118+
your fault. If you need to make more changes, add your commits to
119+
the submitted branch. If the issue can't be resolved easily,
120+
close the PR and make a new one when ready.

doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ def __getattr__(cls, name):
9191

9292
# General information about the project.
9393
project = 'Wpull'
94-
copyright = '2013-2015, Christopher Foo and others'
94+
copyright = '2013-2016, Christopher Foo and others'
9595

9696

9797
# The version info for the project you're documenting, acts as replacement for

doc/help.rst

+12
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,18 @@ When you open a new issue, GitHub provides a link to the guidelines
6262
document. Please read it to learn how to file a good bug report.
6363

6464

65+
How can I help the development of Wpull? What are the development goals?
66+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
67+
68+
Please visit the [GitHub repository](https://github.com/chfoo/wpull).
69+
From there, you can take a look at:
70+
71+
* The Contributing file for specific instructions on how to help
72+
* The issue tracker for current bugs and features
73+
* The Wiki for the roadmap of the project such as goals and statuses
74+
* And the code, of course
75+
76+
6577
How can I chat or ask a question?
6678
+++++++++++++++++++++++++++++++++
6779

0 commit comments

Comments
 (0)