Expand contributing page with advices #69
Conversation
|
Good! I think your workflow can improve even more. Check out my inline comments. |
| virtualenv env | ||
| source env/bin/activate | ||
| python setup.py install |
nemesisdesign
May 11, 2017
Member
python setup.py develop
It installs the current source code without moving it to the env directory, it's very handy for development
python setup.py develop
It installs the current source code without moving it to the env directory, it's very handy for development
| source env/bin/activate | ||
| python setup.py install | ||
| Pre Commit Niceties |
nemesisdesign
May 11, 2017
Member
Here it would be better Style guide enforcement
Here it would be better Style guide enforcement
| Pre Commit Niceties | ||
| ------------------- | ||
|
|
||
| Install ``flake8`` to check for common pitfalls that may have your contribution stopped |
nemesisdesign
May 11, 2017
Member
There's also isort.
There's also isort.
| .. code-block:: shell | ||
| source env/bin/activate | ||
| pip install flake8 |
nemesisdesign
May 11, 2017
Member
pip install requirements-test.txt
contains both isort and flake8
pip install requirements-test.txt
contains both isort and flake8
| source env/bin/activate | ||
| pip install flake8 | ||
| Please use ``runflake8`` before committing your work and opening a pull request |
nemesisdesign
May 11, 2017
Member
The full command is:
./runflake8 && ./runisort
It would be better to list it in its own code block
The full command is:
./runflake8 && ./runisort
It would be better to list it in its own code block
| 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 |
nemesisdesign
May 11, 2017
Member
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.
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.
|
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