mirror of
https://github.com/nvbn/thefuck.git
synced 2025-03-14 14:48:49 +00:00
Move Developing instructions from README to CONTRIBUTING
This makes them easier to find, especially for users opening issues or pull requests. See here for more details: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
This commit is contained in:
parent
57fb6e079a
commit
45f9760a6c
@ -23,3 +23,39 @@ It's only with enough information that we can do something to fix the problem.
|
||||
We gladly accept pull request on the [official
|
||||
repository](https://github.com/nvbn/thefuck) for new rules, new features, bug
|
||||
fixes, etc.
|
||||
|
||||
# Developing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
Install `The Fuck` for development:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
python setup.py develop
|
||||
```
|
||||
|
||||
Run code style checks:
|
||||
|
||||
```bash
|
||||
flake8
|
||||
```
|
||||
|
||||
Run unit tests:
|
||||
|
||||
```bash
|
||||
py.test
|
||||
```
|
||||
|
||||
Run unit and functional tests (requires docker):
|
||||
|
||||
```bash
|
||||
py.test --enable-functional
|
||||
```
|
||||
|
||||
For sending package to pypi:
|
||||
|
||||
```bash
|
||||
sudo apt-get install pandoc
|
||||
./release.py
|
||||
```
|
||||
|
32
README.md
32
README.md
@ -443,37 +443,7 @@ eval $(thefuck --alias --enable-experimental-instant-mode)
|
||||
|
||||
## Developing
|
||||
|
||||
Install `The Fuck` for development:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
python setup.py develop
|
||||
```
|
||||
|
||||
Run code style checks:
|
||||
|
||||
```bash
|
||||
flake8
|
||||
```
|
||||
|
||||
Run unit tests:
|
||||
|
||||
```bash
|
||||
py.test
|
||||
```
|
||||
|
||||
Run unit and functional tests (requires docker):
|
||||
|
||||
```bash
|
||||
py.test --enable-functional
|
||||
```
|
||||
|
||||
For sending package to pypi:
|
||||
|
||||
```bash
|
||||
sudo apt-get install pandoc
|
||||
./release.py
|
||||
```
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
## License MIT
|
||||
Project License can be found [here](LICENSE.md).
|
||||
|
Loading…
x
Reference in New Issue
Block a user