mirror of
https://github.com/ultrasonic/ultrasonic
synced 2024-12-12 16:57:23 +01:00
7790e3bca9
This reflects changes in the project status. Added Contributing guide and rewrite new issue template. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
1.2 KiB
1.2 KiB
Contributing
Ultrasonic development is a community project, and contributions are welcomed.
First, see if your issue haven’t been yet reported here, then, please, first discuss the change you wish to make via a new issue.
Here are a few guidelines you should follow before submitting:
- License Acceptance: All contributions must be licensed as GNU GPLv3 to be accepted.
Use
git commit --signoff
to acknowledge this. - App is migrating to Kotlin programming language: new Pull Requests should be written in this programming language.
- No Breakage: New features or changes to existing ones must not degrade the user experience.
- Coding standards best-practices should be followed, comment generously, and avoid "clever" algorithms. Refactoring existing messes is great, but watch out for breakage.
- No large PR:* Try to limit the scope of PR only to the related issue, so it will be easier to review and test.
Pull Request Process
- Ensure all commits are signed-off.
- Check tests for the new code are added.
- Check code style is passing.
- Check code static analysis is passing.