Merge pull request #149 from ultrasonic/develop

Merge contributing changes in master
This commit is contained in:
Óscar García Amor 2018-01-24 11:09:58 +01:00 committed by GitHub
commit 5ba8999612
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 7 deletions

View File

@ -5,21 +5,29 @@ Ultrasonic development is a community project, and contributions are welcomed.
First, see if your issue havent been yet reported [here](https://github.com/ultrasonic/ultrasonic/issues), First, see if your issue havent been yet reported [here](https://github.com/ultrasonic/ultrasonic/issues),
then, please, first discuss the change you wish to make via [a new issue](https://github.com/ultrasonic/ultrasonic/issues/new). then, please, first discuss the change you wish to make via [a new issue](https://github.com/ultrasonic/ultrasonic/issues/new).
## Contributing Translations
Interested in help to translate Ultrasonic? You can contribute in our
[Transifex team](https://www.transifex.com/ultrasonic/ultrasonic/).
## Contributing Code
By default Pull Request should be opened against **develop** branch, PR against **master** branch should be used only By default Pull Request should be opened against **develop** branch, PR against **master** branch should be used only
for critical bugfixes. for critical bugfixes.
### Here are a few guidelines you should follow before submitting: ### Here are a few guidelines you should follow before submitting:
1. **License Acceptance:** All contributions must be licensed as [GNU GPLv3](LICENSE) to be accepted. 1. **License Acceptance:** All contributions must be licensed as [GNU GPLv3](LICENSE) to be accepted.
Use `git commit --signoff` to acknowledge this. Use `git commit --signoff` to acknowledge this.
2. **App is migrating to [Kotlin](https://kotlinlang.org/) programming language:** new Pull Requests 2. **App is migrating to [Kotlin](https://kotlinlang.org/) programming language:** new Pull Requests
should be written in this programming language. should be written in this programming language.
3. **No Breakage:** New features or changes to existing ones must not degrade the user experience. 3. **No Breakage:** New features or changes to existing ones must not degrade the user experience.
4. **Coding standards** best-practices should be followed, comment generously, and avoid "clever" algorithms. 4. **Coding standards:** best-practices should be followed, comment generously, and avoid "clever" algorithms.
Refactoring existing messes is great, but watch out for breakage. Refactoring existing messes is great, but watch out for breakage.
5. **No large PR:*** Try to limit the scope of PR only to the related issue, so it will be easier to review 5. **No large PR:** Try to limit the scope of PR only to the related issue, so it will be easier to review
and test. and test.
## Pull Request Process ### Pull Request Process
1. Ensure all commits are signed-off. 1. Ensure all commits are signed-off.
2. Check tests for the new code are added. 2. Check tests for the new code are added.

View File

@ -1,2 +1,2 @@
#Mon Jan 22 14:58:03 CET 2018 #Tue Jan 23 22:14:32 CET 2018
AI_VERSION_CODE=61 AI_VERSION_CODE=62