Skip to content

Commit

Permalink
Documenting the steps for contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan Lecocq committed Feb 10, 2014
1 parent 8e624ba commit d655c1b
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 22 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ shovel.egg-info/*
*/shovel/*
.coverage
*/.shovel_tasks
virtualenv/
*.egg
5 changes: 1 addition & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@ python:
- "2.7"
- "3.2"
- "3.3"
before_install:
- "pip install -r requirements.txt"
install: make install
script: make test
script: python setup.py nosetests
18 changes: 0 additions & 18 deletions Makefile

This file was deleted.

17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,20 @@ So now, without any additional work, you can start up the `shovel-server` and
have access to all of the tasks you've been using from the command line. In
this way, as developers we can keep one machine up to date and ready to run
code, and still provide access to staff outside of the project.

Contributing
============
Pull requests and bug reports are welcome. For bugs, please check that the
issue exists on the `master` branch before submitting a bug. Also, please
include an example along with the current behavior and the expected behavior.
Bonus points for adding a failing test.

For pull requests, you'll need to add or change tests in support of your
proposed change. To run the tests:

```python
python setup.py nosetests
```

This installs all the packages required to run tests, runs the tests and
provides coverage information.
6 changes: 6 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[nosetests]
verbosity=0
detailed-errors=1
with-coverage=1
cover-package=shovel
logging-clear-handlers=1
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
package_data = {'shovel': ['templates/*.tpl', 'static/css/*']},
include_package_data = True,
scripts = ['bin/shovel'],
setup_requires = ['nose>=1.3'],
test_suite = 'nose.collector',
tests_require = ['nose>=1.3', 'path.py>=5.0', 'coverage>=3.7'],
classifiers = [
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
Expand Down

0 comments on commit d655c1b

Please sign in to comment.