Remove some of the default cookiecutter stuff from contribution guide

pull/14/head
JamesRamm 2017-02-12 21:48:41 +00:00
rodzic c9d9e1e5eb
commit 1baae40750
1 zmienionych plików z 4 dodań i 50 usunięć

Wyświetl plik

@ -30,13 +30,13 @@ is open to whoever wants to implement it.
Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitHub issues for features. Anything tagged with "feature"
Look through the GitHub issues for features. Anything tagged with "enhancement"
is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
longclaw could always use more documentation, whether as part of the
Longclaw could always use more documentation, whether as part of the
official longclaw docs, in docstrings, or even on the web in blog posts,
articles, and such.
@ -52,61 +52,15 @@ If you are proposing a feature:
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)
Get Started!
------------
Ready to contribute? Here's how to set up `longclaw` for local development.
1. Fork the `longclaw` repo on GitHub.
2. Clone your fork locally::
$ git clone git@github.com:your_name_here/longclaw.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
$ mkvirtualenv longclaw
$ cd longclaw/
$ python setup.py develop
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::
$ flake8 longclaw tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
Pull Request Guidelines
-----------------------
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
1. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4, 3.5 and for PyPy. Check
https://travis-ci.org/JamesRamm/longclaw/pull_requests
and make sure that the tests pass for all supported Python versions.
Tips
----
To run a subset of tests::
$ python -m unittest tests.test_longclaw