AndroidAPS/CONTRIBUTING.md

This document speciffy hints and good practices for source code contributions.

AndroidAPS is community effort and all contributions are welcome! If you wish help us improving AAPS - please read and try to adhere to 
this guidelines, to make the development and process of change aproval as smooth as possible :) 

General rules
=============

* There are plenty of ways you can help, some of them are listed on wiki: 
  https://androidaps.readthedocs.io/en/latest/EN/Getting-Started/How-can-I-help.html
* If you wish to help with documentation or translating: 
  https://androidaps.readthedocs.io/en/latest/EN/translations.html
  
Development guidelines
======================

Coding convetions
-----------------
1. Use Android Studio with default indents (4 chars, use spaces)
2. Use autoformat feature CTRL-ALT-L in every changed file before commit

Committing Changes / Pull Requests
---------------------------------

1. Make fork of repository on github
2. Create separate branch for each feature, branch from most recent dev
3. Commit all changes to your fork
4. When ready, rebase on top of dev and make pull request to main repo

Naming Conventions for Pull Requests / Branches
-----------------------------------------------

TODO

Translations
------------

* If possible, always use Android translation mechanism (with strings.xml and @strings/id) instead of hardcoded texts
* Provide only English strings - all other languages will be crowd translated via Crowdin (https://crowdin.com/project/androidaps and https://crowdin.com/project/androidapsdocs)

Hints
-----

* Start small, it is easier to review smaller changes that affect fewer parts of code 
* Take a look into Issues list (https://github.com/nightscout/AndroidAPS/issues) - maybe there is something you can fix or implement
* For new features, make sure there is Issue to track progress and have on-topic discussion
* Reach out to community, discuss idea on Discord (https://discord.gg/4fQUWHZ4Mw)
* Speak with other developers to minimise merge conflicts. Find out who worked, working or plan to work on speciffic issue or part of app
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00			`This document speciffy hints and good practices for source code contributions.`

AndroidAPS - AAPS, NSClient -> AAPSClient 2022-10-13 15:26:49 +02:00			`AndroidAPS is community effort and all contributions are welcome! If you wish help us improving AAPS - please read and try to adhere to`
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00			`this guidelines, to make the development and process of change aproval as smooth as possible :)`

			`General rules`
			`=============`

			`* There are plenty of ways you can help, some of them are listed on wiki:`
			`https://androidaps.readthedocs.io/en/latest/EN/Getting-Started/How-can-I-help.html`
			`* If you wish to help with documentation or translating:`
			`https://androidaps.readthedocs.io/en/latest/EN/translations.html`

			`Development guidelines`
			`======================`

Update CONTRIBUTING.md 2019-11-28 11:05:26 +01:00			`Coding convetions`
			`-----------------`
			`1. Use Android Studio with default indents (4 chars, use spaces)`
Update CONTRIBUTING.md 2019-11-28 11:06:10 +01:00			`2. Use autoformat feature CTRL-ALT-L in every changed file before commit`
Update CONTRIBUTING.md 2019-11-28 11:05:26 +01:00
Fix a few spelling mistakes across the tree 2022-10-18 02:32:17 +02:00			`Committing Changes / Pull Requests`
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00			`---------------------------------`

			`1. Make fork of repository on github`
			`2. Create separate branch for each feature, branch from most recent dev`
			`3. Commit all changes to your fork`
			`4. When ready, rebase on top of dev and make pull request to main repo`

			`Naming Conventions for Pull Requests / Branches`
			`-----------------------------------------------`

			`TODO`

			`Translations`
			`------------`

			`* If possible, always use Android translation mechanism (with strings.xml and @strings/id) instead of hardcoded texts`
Point contributing docs to crowdin urls 2020-12-30 03:27:30 +01:00			`* Provide only English strings - all other languages will be crowd translated via Crowdin (https://crowdin.com/project/androidaps and https://crowdin.com/project/androidapsdocs)`
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00
			`Hints`
			`-----`

			`* Start small, it is easier to review smaller changes that affect fewer parts of code`
update paths 2020-09-23 15:53:38 +02:00			`* Take a look into Issues list (https://github.com/nightscout/AndroidAPS/issues) - maybe there is something you can fix or implement`
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00			`* For new features, make sure there is Issue to track progress and have on-topic discussion`
Replace Gitter references with Discord 2022-03-06 17:33:03 +01:00			`* Reach out to community, discuss idea on Discord (https://discord.gg/4fQUWHZ4Mw)`
Create CONTRIBUTING.md First draft of contribution guidelines 2019-11-06 12:21:31 +01:00			`* Speak with other developers to minimise merge conflicts. Find out who worked, working or plan to work on speciffic issue or part of app`