mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Update the "how to contribute" document.
Also remove an unwanted dep to Markdown and add a dev_requirement.txt file to use with pip.
This commit is contained in:
parent
0d1edc6450
commit
eb988ab763
3 changed files with 38 additions and 7 deletions
5
dev_requirements.txt
Normal file
5
dev_requirements.txt
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
Jinja2==2.5.5
|
||||
Pygments==1.4
|
||||
docutils==0.7
|
||||
feedgenerator==1.2.1
|
||||
unittest2
|
||||
|
|
@ -1,13 +1,39 @@
|
|||
How to contribute ?
|
||||
===================
|
||||
###################
|
||||
There are many ways to contribute to pelican. You can enhance the
|
||||
documentation, add missing features, fix bugs or just report them.
|
||||
|
||||
There are features missing from pelican and you now exactly how to implement
|
||||
them? That's great! Don't hesitate to fork and make a pull request on github.
|
||||
Don't hesitate to fork and make a pull request on github.
|
||||
|
||||
Set up the development environment
|
||||
==================================
|
||||
|
||||
You're free to setup up the environment in any way you like. Here is a way
|
||||
using virtualenv and virtualenvwrapper. If you don't have them, you can install
|
||||
them using::
|
||||
|
||||
$ pip install virtualenvwrapper
|
||||
|
||||
Virtual environments allow you to work on an installation of python which is
|
||||
not the one installed on your system. Especially, it will install the different
|
||||
projects under a different location.
|
||||
|
||||
To create the virtualenv environment, you have to do::
|
||||
|
||||
$ mkvirtualenv pelican --no-site-package
|
||||
|
||||
Then you would have to install all the dependencies::
|
||||
|
||||
$ pip install -r dev_requirements.txt
|
||||
|
||||
Running the test suite
|
||||
----------------------
|
||||
======================
|
||||
|
||||
It would even be better if you could add tests for this feature. The tests
|
||||
are located under "pelican/tests" and you will need unittests2 to run them::
|
||||
Each time you add a feature, there are two things to do regarding tests:
|
||||
checking that the tests run in a right way, and be sure that you add tests for
|
||||
the feature you are working on or the bug you're fixing.
|
||||
|
||||
The tests leaves under "pelican/tests" and you can run them using the
|
||||
"discover" feature of unittest2::
|
||||
|
||||
python -m unittest2 discover
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -4,7 +4,7 @@ import sys
|
|||
|
||||
VERSION = "2.6.0" # find a better way to do so.
|
||||
|
||||
requires = ['feedgenerator', 'jinja2', 'pygments', 'docutils', 'Markdown']
|
||||
requires = ['feedgenerator', 'jinja2', 'pygments', 'docutils']
|
||||
if sys.version_info < (2,7):
|
||||
requires.append('argparse')
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue