Skip to content

Latest commit

 

History

History
146 lines (96 loc) · 4.25 KB

CONTRIBUTING.rst

File metadata and controls

146 lines (96 loc) · 4.25 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Security Reports

In case you identified a security issue on the project, please report it to the e-mail address given in the security policy.

Report Bugs

Report bugs at https://github.com/rero/rero-ils/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" or "enhancement" is open to whoever wants to implement it.

Write Documentation

rero-ils could always use more documentation, whether as part of the official rero-ils docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/rero/rero-ils/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • 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 rero-ils for local development.

  1. Fork the rero/rero-ils repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/rero-ils.git

  3. Install your local using the installation procedure.

  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 tests:

    $ ./run-tests.sh

    The tests will provide you with test coverage and also check PEP8 (code style), PEP257 (documentation), flake8 as well as build the Sphinx documentation and run doctests.

  6. Add the .gitmessage.txt file to your git configuration:

    # globally
$ git config --global commit.template /path/.gitmessage.txt

# locally
$ git config --local commit.template .gitmessage.txt

    The Signed-off-by message is not used anymore, so you can avoid -s parameters when committing. But of course, you can modify your own version of the .gitcommit.txt in order to add you own Co-Authored-by message.

  7. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -s
$ git push origin name-of-your-bugfix-or-feature

  8. 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 and must not decrease test coverage.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.
  3. The pull request should work for Python 2.7, 3.3, 3.4 and 3.5. Check https://travis-ci.org/rero/rero-ils/pull_requests and make sure that the tests pass for all supported Python versions.