Add CONTRIBUTION guide #205
Conversation
|
|
||
| Please follow [PEP8](https://www.python.org/dev/peps/pep-0008/) guide. | ||
| See [Running Test](./README.md#running-tests) and [Linting](./README.md#linting) for further instructions. | ||
|
|
There was a problem hiding this comment.
Should we add a step here about running the formatter?
pipenv run fmt or make fmt or black . -l 120
There was a problem hiding this comment.
Thanks for feedback. Added make ftm to styleguide section.
|
Some points to discuss? :-) |
| install: | ||
| - "pip install pipenv" | ||
| - "pipenv install --dev --skip-lock" | ||
| - "pipenv install coveralls" |
There was a problem hiding this comment.
IMO this coveralls stuff should be a totally separate PR but...
You shouldn't use pipenv install this dependency here.
- Either add it to the
Pipfileso that it gets installed along with thedevdependencies - install it directly with pip in the first install step.
pip install pipenv coveralls
| pytest-cov="*" | ||
| pylint = "*" | ||
| coveralls = "*" |
There was a problem hiding this comment.
Updates to the Pipfile should always be accompanied by a new Pipfile.lock
Run pipenv lock to regenerate a new lockfile.
However, if you are on a windows machine it may not generate the correct dependencies for a deployment. If so let me know and I would be happy to generate it for you,
|
@gribok Can I remove the coverage stuff from this branch and merge it? |
2 participants
Based on #169, provides first version of contrib guide.