Contribution guidelines

Contribution guidelines

Using the issue tracker

Use the issue tracker for documenting bug reports and feature requests.
Guidelines for bug requests:

• Use GitHub issue search to check if the issue (or similar issue) has already been reported.
• Check if the issue has been fixed in the current version.
• Report the issue in detail giving information about the following:
  1. What is your environment (OS, program versions, e.g. maven, java, Browser)?
  2. What steps will reproduce the issue?
  3. What would you expect to be the outcome? Guidelines for feature requests:
• Before requesting a new feature think about whether your idea fits into the scope of the project.
• Provide as much detail as possible.

Coding guidelines

In Qanary we try to follow the hard-and-fast rules for writing Java programs presented here: https://google.github.io/styleguide/javaguide.html.

Git branching

• Create a new branch when working on an issue:
  

 git checkout -b myissue

• Write a clear log message for your commits:
  

 git commit -m "This is a clear log message"

• When you finish with the issue merge your branch back into master:
  

 git checkout master
 git merge --no-ff myissue

Writing tests

Write unit tests for new code you create.

Versioning

We follow the semantic versioning policy (for more see http://semver.org/): Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

Code reviews

TODO