mirror of
https://github.com/nvbn/thefuck.git
synced 2025-01-31 02:01:13 +00:00
Move Developing instructions from README to CONTRIBUTING (#757)
* 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/ * fixup! Move Developing instructions from README to CONTRIBUTING
This commit is contained in:
parent
4fb85b0a92
commit
7e6d1dbc7c
@ -23,3 +23,37 @@ It's only with enough information that we can do something to fix the problem.
|
|||||||
We gladly accept pull request on the [official
|
We gladly accept pull request on the [official
|
||||||
repository](https://github.com/nvbn/thefuck) for new rules, new features, bug
|
repository](https://github.com/nvbn/thefuck) for new rules, new features, bug
|
||||||
fixes, etc.
|
fixes, etc.
|
||||||
|
|
||||||
|
# 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
|
||||||
|
```
|
||||||
|
32
README.md
32
README.md
@ -444,37 +444,7 @@ eval $(thefuck --alias --enable-experimental-instant-mode)
|
|||||||
|
|
||||||
## Developing
|
## Developing
|
||||||
|
|
||||||
Install `The Fuck` for development:
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||||
|
|
||||||
```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
|
|
||||||
```
|
|
||||||
|
|
||||||
## License MIT
|
## License MIT
|
||||||
Project License can be found [here](LICENSE.md).
|
Project License can be found [here](LICENSE.md).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user