Skip to content

CONTRIBUTING.md contains contributor guide

Created by: benoitbryon

Here is a proposal around documentation for contributors.

Here are planned changes:

  • CONTRIBUTING.md provides contributor's documentation. It doesn't have to be complete and perfect in this pull-request: could be improved by future pull-requests.
  • separate "production" and "development" documentation. As an example, docs/install.md focuses on production setup, whereas CONTRIBUTING.md focuses on development environment.
  • README and CONTIBUTING list project's online resources , i.e. issues, continuous integration, roadmap, documentation...
  • In freshly installed development environment using CONTRIBUTING.md, tests pass.

Merge request reports