Skip to content

Contributing

Gerald edited this page Jul 31, 2018 · 3 revisions

Any contributions are welcome (code, tests, documentation, bug reports & fixes, features, feature-requests, ... ).

Coding Rules / Development Guidelines

It would be nice if you follow the SonarQube Developer Guidelines or stick close to them.

All tests must be passing.

Branchs and Pull Requests (PRs)

There are two main branches in the project: master and development.

Any contributions from external contributors / forked repositories must be pull-requested into the development branch, not the master. This is because SonarCloud analysis is not supported for external PRs and therefore have to be merged into development first. Committers / Code Reviewers have to ensure the contribution has sufficent quality and passes the quality gates.

Committers with write permission on the repository may open internal PRs from custom branches on this repository (non-forked) to be merged into the master branch.

So there are two paths into master branch:

  • FROM: forked repository
    • -> PR into development (from fork) -> PR into master (from development)
  • FROM: this repository / branch
    • -> PR into development (from branch) -> PR into master (from development)
    • -> PR into master (from branch)

PRs for the master branch have to be reviewed and approved by one of the commiters, all checks must pass.

Copyright

Copyright owner of the plugin is DevCon5 GmbH, Switzerland.

By committing a code change or opening a pull request, the authors of a change agrees to transfer the copyright to DevCon5 GmbH. If you do not agree to this, don't open a pull request or commit a change!

The main reason is to stay in control of the code and not end up with a patchwork of different copyrights.

DevCon5 is commited to keep this plugin open source, licensed under LGPL v3. The right to create a dual-licensed version for commercial purposes is reserved.

Clone this wiki locally