Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 2.48 KB
Raw

If your are reading this page, it means that you may be volunteer to help us. Great news and welcome !

How to contribute to OrbisGIS?

You can contribute to OrbisGIS thanks to the 3 following items

  1. Create an issue
  2. Propose a code (bug fix, new functionnality, ...)
  3. Others

1- Create an issue

You are invited to add an issue if you:

  • found a bug,
  • want to propose new idea / functionnality.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include the following elements:

    • A clear & simple title,
    • Your Operating System,
    • Your Java version,
    • Your OrbisGIS version,
    • A description, as detailed as possible, with elements to be able to reproduce the bug,
    • If possible, the error message or the log informations,

Want to propose something?

You can propose improvements, new functionnalities, ... in an issue. The team will consider your proposal and if it is unanimous, we will see how to develop it. Try to be as much clear as possible when exposing your idea.

2- Propose a code

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request (PR) with your patch.

  • Ensure:

    • your branch is up-to-date with the target branch,
    • your PR compiles without errors,
    • (if possible) you provided a unit test,
    • the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Legal issues

For legal reasons, contributors are asked to provide a contributor license agreement. We invite each contributor to send a mail to the OrbisGIS developer mailing list.

The mail need to include the following statement:

"I wrote the code, it's mine, and I'm contributing it to OrbisGIS for distribution licensed under the GPL 3.0."

3- Others

Translate the app

You can help us by translating OrbisGIS into your langage. To do so, you are invited to consult this page.

Thanks for your future contributions! ❤️ ❤️

The OrbisGIS Team

N.B this contribution page is freely inspired from https://github.com/rails/rails/blob/master/CONTRIBUTING.md