Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 3.64 KB

CONTRIBUTING.rst

File metadata and controls

120 lines (85 loc) · 3.64 KB
Raw

Contributing

jexia-cli is open-source and very open to contributions.

If you're part of a corporation with an NDA, and you may require updating the license. See Updating Copyright below

Submitting issues

Issues are contributions in a way so don't hesitate to submit reports on the official bugtracker.

Provide as much informations as possible to specify the issues:

  • the jexia-cli version used
  • a stacktrace
  • installed applications list
  • a code sample to reproduce the issue
  • ...

Submitting patches (bugfix, features, ...)

If you want to contribute some code:

  1. fork the official jexia-cli repository
  2. Ensure an issue is opened for your feature or bug
  3. create a branch with an explicit name (like my-new-feature or issue-XX)
  4. do your work in it
  5. Commit your changes. Ensure the commit message includes the issue. Also, if contributing from a corporation, be sure to add a comment with the Copyright information
  6. rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase)
  7. add your change to the changelog
  8. submit your pull-request
  9. 2 Maintainers should review the code for bugfix and features. 1 maintainer for minor changes (such as docs)
  10. After review, a maintainer a will merge the PR. Maintainers should not merge their own PRs

There are some rules to follow:

  • your contribution should be documented (if needed)
  • your contribution should be tested and the test suite should pass successfully
  • your code should be mostly PEP8 compatible with a 80 characters line length (use flake8 to test)
  • your contribution should support both Python 2 and 3 (use tox to test)

You need to install some dependencies to develop on jexia-cli:

$ pip install -e .[dev]

An Invoke tasks.py is provided to simplify the common tasks:

$ inv -l
Available tasks:

    all                Run tests, reports and packaging
    clean              Cleanup all build artifacts
    cover              Run tests suite with coverage
    deps               Install or update development dependencies
    dist               Package for distribution
    doc                Build the documentation
    qa                 Run a quality report
    test-integration   Run integration tests suite
    test-unit          Run unit tests suite
    tox                Run tests against Python versions

To ensure everything is fine before submission, use tox. It will run the test suite on all the supported Python version and ensure the documentation is generating.

$ tox

You also need to ensure your code is compliant with the jexia-cli coding standards:

$ inv qa

To ensure everything is fine before commiting, you can launch the all in one command:

$ inv qa tox

It will ensure the code meet the coding conventions, runs on every version on python and the documentation is properly generating.

Updating Copyright

If you're a part of a corporation with an NDA, you may be required to update the LICENSE.

  1. Check with your legal department first.
  2. Add an appropriate line to the LICENSE file.
  3. When making a commit, add the specific copyright notice.

Double check with your legal department about their regulations. Not all changes constitute new or unique work.