From 7e6d1dbc7c6cf212d8e830f412609988de188dbb Mon Sep 17 00:00:00 2001 From: Joseph Frazier <1212jtraceur@gmail.com> Date: Wed, 3 Jan 2018 13:00:20 -0500 Subject: [PATCH] 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 --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 32 +------------------------------- 2 files changed, 35 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8e8d74..592a8ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 repository](https://github.com/nvbn/thefuck) for new rules, new features, bug 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 +``` diff --git a/README.md b/README.md index e686d06..50bf49a 100644 --- a/README.md +++ b/README.md @@ -444,37 +444,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).