Energenie EG-PMS Manuel d'utilisateur télécharger pdf (Page 15)

pickups Documentation, Release 0.7.0

• Keep the scope as narrow as possible, to make it easier to implement.

• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up pickups for local development.

1. Fork the pickups repo on GitHub (Howto Fork A Repo).

2. Clone your fork locally:

$ git clone [email protected]:your_name_here/pickup.git

3. Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

4. When you’re done making changes, check that your changes pass style and unit tests, including testing other

Python versions with tox:

$ tox

To get tox, just pip install it.

5. 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. Your tests should have reach coverage of 95% or higher.

3. 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.

4. Follow the Python Styleguide with the exception that lines can be up to 120 characters long.

5. The pull request should work for Python 2.7, and 3.4, and for PyPy. Check https://travis-

ci.org/maiksensi/pickups under pull requests for active pull requests or run the tox command and make sure

that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test test/test_pickups.py

Github’s documentation on how to create a pull-request can be found in the User Documentation.

3.3. Developer Documentation 11

1 2 ... 10 11 12 13 14 15 16 17 18 19 20 ... 29 30

Pas de commentaire

Energenie EG-PMS Manuel d'utilisateur Page 15