Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.39 KB

How to contribute to Dolibarr

Bug reports and feature requests

Issues are tracked at Doliforge

You need to create an account before being able to use the "Bugs & Tasks" feature.

  1. Use the search engine to check if nobody's already reported your problem.
  2. Choose the right section. (Bugs or Task and Feature Request).
  3. Report with as much detail as possible (Use screenshots or even screencasts whenever possible).

Code

Basic workflow

  1. Fork the GitHub repository.
  2. Clone your fork.
  3. Choose a branch(See the Branches section below).
  4. Commit and push your changes.
  5. Make a pull request.

Branches

Unless you're fixing a bug, all pull request should be made against the develop branch.

If you're fixing a bug, it is preferred that you cook your fix and pull request it against the oldest version affected that's still supported.

We officially support versions N, N − 1 and N − 2 for N the latest version available.

Choose your base branch accordingly.

General rules

Please don't edit the ChangeLog file. A project manager will update it from your commit messages.

Commits

Use clear commit messages with the following structure:

KEYWORD Short description

Long description (Can span accross multiple lines).

Where KEYWORD is one of:

  • "FIXED:" for bug fixes (May be followed by the bug number i.e: #456)
  • "NEW:" for new features (May be followed by the task number i.e: #123)
  • void, don't put a keyword if the commit is not introducing feature or closing a bug.

Resources

Developer documentation

Translations

en_US and delta languages (i.e: fr_XX) are maintained in the repository. See Code section above.

All other translations are managed online at Transifex.

Join an existing translation team or create your own and translate into the interface.

Your translations will be available in the next major release.

Resources

Translator documentation

Documentation

The project's documentation is maintained on the Wiki.

You need to create an account before being able to edit.