Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.57 KB

File metadata and controls

41 lines (32 loc) · 2.57 KB

How to contribute

Branch naming

We are using a custom version of GitFlow methodology for naming the branches:

  • feature: feature/*
  • hotfix: hotfix/*
  • documentation: doc/*
  • asset: asset/*
  • bug: bug/*

Moreover, the names of the branches have to be meaningful.

Have you found a bug?

  1. Verify that the bug has not been reported yet by searching on Issues.
  2. If it does not exist, then open a new issue.

Have you fixed a bug?

  1. Open a pull request.
  2. Make sure that you describe the problem and your solution.
  3. Include all related issue numbers if applicable.

Do you want to add a new feature or change an existing one?

  1. Verify that the feature or change is not implemented yet by another user by searching on Issues.
  2. Send an email to appaxer@gmail.com and describe the feature or the change.
  3. If it is approved, then open a new issue.
  4. Open a feature branch and perform there all the changes you want.
  5. When you have finished, open a pull request.
  6. Make sure that you describe the new feature or the changes you have performed.
  7. Include the related issue number.

Have you found anything wrong in the documentation?

  1. Verify that the documentation issue has not been reported yet by searching on Issues.
  2. If it does not exist, then open a new issue.

Do you have any question?

  1. Verify that your question has not been asked yet by searching on Q&A.
  2. If it does not exist, then open a new Q&A discussion.

Coding Conventions

We follow the standard Kotlin code coventions.