Skip to content

Commit

Permalink
doc: Add testing notes, how to help, update current year
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
chfoo committed Jun 13, 2016
1 parent 215000a commit c634ebf
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -91,6 +91,16 @@ feature to avoid any rejection and disappointment.
One branch per bug/feature. Don't stack PR on top of other PR branches!


### Testing

Testing can be done by using [Nose](http://nose.readthedocs.io/).
As described in Nose documentation, run `nosetests3` in the top
level of the project directory.

Additionally, the project is [configured to use the free Travis CI]
(https://travis-ci.org/chfoo/wpull).


### Making the PR

When you file a pull request, a template will appear reminding you
Expand All @@ -101,3 +111,10 @@ of this document. It will also remind you to:
* Describe *what* you changed and *why* you changed them.
* Set GitHub merge options to merge into `develop` if you branch
from `develop`.

GitHub will also run tests on the code. If there is an error,
please take a look at to see if it is related to your PR.
See Testing above. Sometimes the build is broken and may not be
your fault. If you need to make more changes, add your commits to
the submitted branch. If the issue can't be resolved easily,
close the PR and make a new one when ready.
2 changes: 1 addition & 1 deletion doc/conf.py
Expand Up @@ -91,7 +91,7 @@ def __getattr__(cls, name):

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


# The version info for the project you're documenting, acts as replacement for
Expand Down
12 changes: 12 additions & 0 deletions doc/help.rst
Expand Up @@ -62,6 +62,18 @@ When you open a new issue, GitHub provides a link to the guidelines
document. Please read it to learn how to file a good bug report.


How can I help the development of Wpull? What are the development goals?
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Please visit the [GitHub repository](https://github.com/chfoo/wpull).
From there, you can take a look at:

* The Contributing file for specific instructions on how to help
* The issue tracker for current bugs and features
* The Wiki for the roadmap of the project such as goals and statuses
* And the code, of course


How can I chat or ask a question?
+++++++++++++++++++++++++++++++++

Expand Down

0 comments on commit c634ebf

Please sign in to comment.