talares.github.io/contributing.html at master · talares/talares.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
---
layout: main
title: Talares | Contributing
---
<article>

  <h1>Contributing</h1>
  <hr>

  <p>
    Contributions to the project through pull requests are more then welcome. Please keep to these guidelines before
    issuing a pull request:
  </p>

  <ul>
    <li>
      Create a ticket of the work you intend to do if none is present. Add the ticket number in your commit message(s).
    </li>
    <li>
      Create a branch for your ticket with a descriptive name.
    </li>
    <li>
      Maintain or improve code quality with your contribution. Only clean, well documented and useful code will be
      accepted. Stick to the well known code quality principles (DRY, YAGNI, KISS).
    </li>
    <li>
      New features should be implemented in Scala first and if applicable be made available through the Java API.
    </li>
    <li>
      New functionality should be accompanied by corresponding tests.
    </li>
    <li>
      Changes in the public facing API should be accompanied by relevant changes in the documentation.
    </li>
  </ul>

</article>