Expand contributing page with advices #69
Conversation
docs/source/general/contributing.rst
Outdated
|
|
||
| virtualenv env | ||
| source env/bin/activate | ||
| python setup.py install |
There was a problem hiding this comment.
python setup.py develop
It installs the current source code without moving it to the env directory, it's very handy for development
docs/source/general/contributing.rst
Outdated
| source env/bin/activate | ||
| python setup.py install | ||
|
|
||
| Pre Commit Niceties |
There was a problem hiding this comment.
Here it would be better Style guide enforcement
docs/source/general/contributing.rst
Outdated
| Pre Commit Niceties | ||
| ------------------- | ||
|
|
||
| Install ``flake8`` to check for common pitfalls that may have your contribution stopped |
docs/source/general/contributing.rst
Outdated
| .. code-block:: shell | ||
|
|
||
| source env/bin/activate | ||
| pip install flake8 |
There was a problem hiding this comment.
pip install requirements-test.txt
contains both isort and flake8
docs/source/general/contributing.rst
Outdated
| source env/bin/activate | ||
| pip install flake8 | ||
|
|
||
| Please use ``runflake8`` before committing your work and opening a pull request |
There was a problem hiding this comment.
The full command is:
./runflake8 && ./runisort
It would be better to list it in its own code block
docs/source/general/contributing.rst
Outdated
| Please use ``runflake8`` before committing your work and opening a pull request | ||
|
|
||
| .. note:: | ||
| To speed things up you can add your virtual environment directory to the list of the excluded directories in the ``runflake8`` script |
There was a problem hiding this comment.
it would be even better to use virtualenvwrapper which wouldn't give you this additional problem. Check it out.
Virtualenv management and creation would then become:
# create virtualenv
mkvirtualenv --python=python3 netjsonconfig
# activate virtualenv
workon netjsonconfig
# deactivate virtualenv
deactivate
# remove virtualenv
rmvirtualenv netjsonconfig
I leave it up to you to change the text to suggest mkvirtualenv or leave it as it is now.
edoput
force-pushed
the
expand-contributing
branch
from
2559f2d
to
78256af
Compare
|
I mentioned |
This information provides instructions on how to configure the development environment and what are the tools to check new work and generate documentation
As it was difficult to start contributing this may be of interest to other contributors