You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GnuCash Android is built by people like you! Please [join us](https://github.com/codinguser/gnucash-android).
2
+
3
+
## Git and Pull requests
4
+
* Contributions are submitted, reviewed, and accepted using Github pull requests. [Read this article](https://help.github.com/articles/using-pull-requests) for some details. We use the _Fork and Pull_ model, as described there.
5
+
* You can maintain your stable installation of GnuCash and test with another installation.
6
+
The two instances of GnuCash Android will live side-by-side on your device and not affect each other. You can install the development version by executing `gradle installDD` inside the root project directory
7
+
* The latest changes are in the `develop` branch.
8
+
* The master branch contains only stable releases.
9
+
* Pull requests to the `master` branch will be rejected.
10
+
* Make a new branch for every feature you're working on.
11
+
* Try to make clean commits that are easily readable (including descriptive commit messages!)
12
+
* Test before you push make sure all test pass on your machine.
13
+
* Unit tests can be run with `gradle test`
14
+
* UI tests can be run with `gradle cDDAT`
15
+
* Make small pull requests that are easy to review but make sure they do add value by themselves.
16
+
17
+
## Coding style
18
+
* Do write comments. You don't have to comment every line, but if you come up with something thats a bit complex/weird, just leave a comment. Bear in mind that you will probably leave the project at some point and that other people will read your code. Undocumented huge amounts of code are nearly worthless!
19
+
* Please make sure to document every method you write using Javadoc, even if the method seems trivial to you
20
+
* See [this guide](http://www.oracle.com/technetwork/articles/java/index-137868.html) on how to write good Javadoc comments
21
+
* Don't overengineer. Don't try to solve any possible problem in one step, but try to solve problems as easy as possible and improve the solution over time!
22
+
* Do generalize sooner or later! (if an old solution, quickly hacked together, poses more problems than it solves today, refactor it!)
23
+
* Keep it compatible. Do not introduce changes to the public API, or configurations too lightly. Don't make incompatible changes without good reasons!
24
+
25
+
## Translation
26
+
* Tranlations for GnuCash Android are managed using [CrowdIn](crowdin.com/project/gnucash-android)
27
+
* You can sign up for an account and create/vote for translations.
28
+
* Translations will not be accepted via pull requests
29
+
30
+
## Documentation
31
+
* Documentation should be kept up-to-date. This means, whenever you add a new API method, add a new hook or change the database model, pack the relevant changes to the docs in the same pull request.
0 commit comments