New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add contributor documentation #1

Open

opalmer opened this issue Dec 1, 2013 · 0 comments

Assignees

Labels

Member

opalmer commented Dec 1, 2013

Add some basic documentation to aid contributors in getting started. Similar to Twisted's or sqlalchemy's pages this should:

how to find or contact developers
location of repositories
local environment setup
- virtualenvs
- local installation from repos (don't forget --egg)
writing code
- setup.py (mainly requirements -- when to add them, when not to)
- coding style
- interpreter version support
documentation
- format
- local testing and generation
testing
- travis-ci
- coveralls.io
- nose

As per pyfarm/pyfarm-master#22, more targeted information for contributors should also be added to the README file for each individual repo.

ghost assigned opalmer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment