MirroredRepos/thefuck
1
0
Fork 0
mirror of https://github.com/nvbn/thefuck.git synced 2025-03-20 09:39:01 +00:00
Code Issues Releases Wiki Activity

Updated CONTRIBUTING.md to reflect what I learned at hackillinois

Browse Source
This commit is contained in:
Josh Martin 2020-03-04 21:19:29 -05:00 committed by Josh Martin
parent 2ced7a7f33
commit 63fc9e3f08
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -19,11 +19,6 @@ the following basic information:
It's only with enough information that we can do something to fix the problem. It's only with enough information that we can do something to fix the problem.
# Make a pull request
We gladly accept pull request on the [official
repository](https://github.com/nvbn/thefuck) for new rules, new features, bug
fixes, etc.
# Developing # Developing
[Create and activate a Python 3 virtual environment.](https://docs.python.org/3/tutorial/venv.html) [Create and activate a Python 3 virtual environment.](https://docs.python.org/3/tutorial/venv.html)
@ -35,6 +30,20 @@ pip install -r requirements.txt
python setup.py develop python setup.py develop
``` ```
Installing code coverage:
```bash
pip install -U coveralls
```
Run code coverage:
```bash
coverage run --source=thefuck,tests -m py.test -v --capture=sys tests
coverage html
```
Run code style checks: Run code style checks:
```bash ```bash
@ -59,3 +68,12 @@ For sending package to pypi:
sudo apt-get install pandoc sudo apt-get install pandoc
./release.py ./release.py
``` ```
# Make A Pull Request
We gladly accept pull request on the [official
repository](https://github.com/nvbn/thefuck) for new rules, new features, bug
fixes, etc.
**When making a PR, please make sure that your code has no errors in terms of unit tests, coverage, or linting errors.** This will save you and the reviewers a lot of time in the end.