2016-09-27 13:43:43 +02:00
NewPipe contribution guidelines
===============================
2015-12-22 16:14:56 +01:00
2016-09-27 14:14:59 +02:00
READ THIS GUIDELINES CAREFULLY BEFORE CONTRIBUTING.
2015-12-22 16:14:56 +01:00
2016-09-27 14:14:59 +02:00
## Crash reporting
2015-12-22 16:14:56 +01:00
2016-09-27 14:14:59 +02:00
Do not report crashes in the GitHub issue tracker. NewPipe has an automated crash report system that will ask you to send a report if a crash occures.
2015-12-22 16:14:56 +01:00
2016-09-27 13:43:43 +02:00
## Issue reporting/feature request
2015-12-22 16:14:56 +01:00
2016-09-27 13:43:43 +02:00
* Search the [existing issues ](https://github.com/theScrabi/NewPipe/issues ) first to make sure your issue/feature hasn't been reported/requested before
* Check if this issue/feature is already fixed/implemented in the repository
* If you are an android/java developer you are always welcome to fix/implement an issue/a feature yourself
2015-12-22 16:14:56 +01:00
2017-02-12 00:16:41 +01:00
## Bugfixing
* If you want to help NewPipe getting bug free, you can send me a mail to tnp@newpipe.schabi.org to let me know that you intent to help, and than register at our [sentry ](https://support.schabi.org ) setup.
2016-01-05 20:56:40 +01:00
## Translation
2015-12-22 16:14:56 +01:00
* NewPipe can be translated on [weblate ](https://hosted.weblate.org/projects/newpipe/strings/ )
2016-09-27 13:43:43 +02:00
## Code contribution
2015-12-23 09:31:11 +01:00
2016-09-27 14:14:59 +02:00
* Stick to NewPipe style guidelines (just look the other code and than do it the same way :) )
* Do not bring nonfree software/binary blobs into the project (keep it google free)
* Stick to [f-droid contribution guidelines ](https://f-droid.org/wiki/page/Inclusion_Policy )
* Make changes on a separate branch, not on the master branch (Feature-branching)
2016-09-27 13:43:43 +02:00
* When submitting changes, you agree that your code will be licensed under GPLv3
2016-09-27 14:14:59 +02:00
* Please test (compile and run) your code before you submit changes!!!
* Try to figure out you selves why CI fails, or why a merge request collides
* Please maintain your code after you contributed it.
* Respond yourselves if someone request changes or notifies issues
2015-12-23 09:31:11 +01:00
2015-12-22 16:14:56 +01:00
## Communication
2017-02-11 22:26:00 +01:00
* WE DO NOW HAVE A MAILING LIST: [newpipe@list.schabi.org ](https://list.schabi.org/cgi-bin/mailman/listinfo/newpipe ).
2016-09-27 14:14:59 +02:00
* If you want to get in contact with me or one of our other contributors you can send me an email at tnp(at)schabi.org
2016-01-05 20:56:40 +01:00
* Feel free to post suggestions, changes, ideas etc!