Skip to content
This repository has been archived by the owner on Oct 12, 2021. It is now read-only.

Latest commit

 

History

History
21 lines (14 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

21 lines (14 loc) · 1.09 KB
Raw

Contributing to Jahia2wp

As an open source project, we always welcome contributions of many forms.

Examples of contributions include:

  1. Submitting issues for any feature enhancements, bugs or documentation problems.
  2. Fixing open issues by sending PRs
  3. Adding documentation

Warning: In order to ease the process, and set expectations, be sure to submit a PR after discussing it in an issue. Non-trivial pull requests (anything more than fixing a typo) without issues will be closed!

When discussing changes and issues, please read and follow our Code of Conduct.

As you have surely seen before reaching this page, most of the project is written in python. Hence a few practices that should guide you:

  1. code should respect flake8 conventions
  2. new code should come with automatic tests
  3. all tests (new and existing) should pass
  4. coverage should not decrease (codcov will automatically comment the PRs with a coverage report)
  5. high level documentation should be written in markdown