Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (81 loc) · 5.31 KB

CONTRIBUTING.md

File metadata and controls

112 lines (81 loc) · 5.31 KB

How to Contribute

isbnlib has a very small code base, so it is a good project to begin your adventure in open-source.

NOTE: By contributing you agree with the license terms (LGPL v3) of the project.

Main Steps

  1. Make sure you have a GitHub account
  2. Submit a ticket for your issue or idea (help), on https://github.com/xlcnd/isbnlib/issues, (if possible wait for some feedback before any serious commitment... :)
  3. Fork the repository on GitHub and clone it locally (help).
  4. pip install -r requirements-dev.txt (at your local directory).
  5. Do your code... (remember the code must run on python 2.6, 2.7, 3.3, 3.4, pypy and be OS independent It is easier if you start to write in python 3 and then adapt for python 2) (you will find Travis very handy for testing with this requirement!)
  6. Write tests for your code using nose and put then in the directory isbnlib/test
  7. Pass all tests and with coverage > 90%. Check the coverage in Coveralls or locally with the command nosetests --with-coverage --cover-package=isbnlib.
  8. Check if all requirements are fulfilled!
  9. Push your local changes to GitHub and make there a pull request (help) using dev as base branch (by the way, we follow the fork & pull model with this small change).

NOTE: Travis, coverage, flake8 and pylint, have already configuration files adapted to the project.

Style

Your code must be PEP8 compliant and be concise as possible (use yapf then check it with flake8 and pylint).

Use doc strings (PEP257) for users and comments (few) as signposts for fellow developers. Make your code as clear as possible.

Red Lines

Don't submit pull requests that are only comments to the code that is already in the repo! Don't expect kindness if you do that :) You can comment and give suggestions on the code at the issues page.

No doc tests! Remember point 6 above.

Don't submit pull requests without checking point 8!

Suggestions

Read the code in a structured way at sourcegraph.

Goto issues/enhancement for possible enhancements to the code. If you have some idea that is not there enter your own. Select some focused issue and enter some comments on how you plan to tackle it.

Take a look at the project isbntools and see if your code can be written as a pluggin (a new metadata provider) or as a user script [they are easier!]. For contributions to the core, you cannot use external libraries (except standard lib), and must be pure python. There is a package prefix isbntools.contrib where these requirements are not applied (download a template package).

Important

If you don't have experience with these issues, don't be put off by these requirements, see them as a learning opportunity. Thanks!

Resources (for newbies)

Minimum git & GitHub

More Resources by Topic

Topic Resource
fork a repo https://help.github.com/articles/fork-a-repo
pull request https://help.github.com/articles/using-pull-requests/
git log https://www.youtube.com/watch?v=U8GBXvdmHT4
local feature branchs https://www.youtube.com/watch?v=ImhZj6tpXLE
git & GitHub tips https://github.com/tiimgreen/github-cheat-sheet
http://cbx33.github.io/gitt/intro.html
http://git-scm.com/documentation
http://gitimmersion.com/
http://www.youtube.com/playlist?list=PLq0VzNtDZbe9QLq8YCizFN2TVWvlLjrvX
nosetests http://pythontesting.net/framework/nose/nose-introduction/
contributing https://www.youtube.com/watch?v=IXnNgLmd6BM
http://openhatch.org/missions
http://opensource.com/resources/how-get-started-open-source