New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand contributing page with advices #69

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@edoput
Member

edoput commented May 11, 2017

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

@coveralls

This comment has been minimized.

coveralls commented May 11, 2017

Coverage Status

Coverage remained the same at 100.0% when pulling 2559f2d on EdoPut:expand-contributing into 9e58e6b on openwisp:master.

@nemesisdesign

Good! I think your workflow can improve even more. Check out my inline comments.

virtualenv env
source env/bin/activate
python setup.py install

This comment has been minimized.

@nemesisdesign

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

source env/bin/activate
python setup.py install
Pre Commit Niceties

This comment has been minimized.

@nemesisdesign

nemesisdesign May 11, 2017

Member

Here it would be better Style guide enforcement

Pre Commit Niceties
-------------------
Install ``flake8`` to check for common pitfalls that may have your contribution stopped

This comment has been minimized.

@nemesisdesign

nemesisdesign May 11, 2017

Member

There's also isort.

.. code-block:: shell
source env/bin/activate
pip install flake8

This comment has been minimized.

@nemesisdesign

nemesisdesign May 11, 2017

Member

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

This comment has been minimized.

@nemesisdesign

nemesisdesign May 11, 2017

Member

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

This comment has been minimized.

@nemesisdesign

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.

@edoput edoput force-pushed the edoput:expand-contributing branch from 2559f2d to 78256af May 15, 2017

@coveralls

This comment has been minimized.

coveralls commented May 15, 2017

Coverage Status

Coverage remained the same at 100.0% when pulling 78256af on EdoPut:expand-contributing into 9e58e6b on openwisp:master.

@edoput

This comment has been minimized.

Member

edoput commented May 15, 2017

I mentioned virtualenvwrapper but the development workflow is too personal to require something from a contributor, I left a note to say it's a nicer option to use

@nemesisdesign

👍

nemesisdesign added a commit that referenced this pull request May 15, 2017

@edoput edoput deleted the edoput:expand-contributing branch Jul 7, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment