mirrors/NewPipe
1
0
Fork 0
mirror of https://github.com/TeamNewPipe/NewPipe synced 2024-12-23 16:40:32 +00:00
Code Issues Releases Wiki Activity

update contribution guidelines

Browse Source
This commit is contained in:
Christian Schabesberger 2016-09-27 13:43:43 +02:00
parent 2b89e24a4b
commit 360a44b5a0
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -1,33 +1,31 @@
#Contribution NewPipe contribution guidelines
===============================
This document contains guidelines on making contributions to NewPipe. READ THIS GUIDELINES CAREFULLY BEVORE CONTRIBUGING.
## Programming ## Crashreporting
* Follow the [Google Style Guidelines](https://google.github.io/styleguide/javaguide.html) Do not report crashes in the github issue tracker. NewPipe has an automated crashreport system that will ask you to send a report if a crash occures.
* Make a new feature on a separate branch, not on the master branch
* Make a [pull request](https://github.com/theScrabi/NewPipe/pulls) if you're done with your changes
* When submitting changes, you agree that your code will be GPLv3 licensed
## Commit messages ## Issue reporting/feature request
* The subject line of your commit message shouldn't be longer than 72 characters * Search the [existing issues](https://github.com/theScrabi/NewPipe/issues) first to make sure your issue/feature hasn't been reported/requested before
* Try to keep each line of your commit message 72 characters to ensure proper * Check if this issue/feature is already fixed/implemented in the repository
compatibility with all git tools * If you are an android/java developer you are always welcome to fix/implement an issue/a feature yourself
* [This guide](http://chris.beams.io/posts/git-commit/) goes more in depth on what makes a good commit message
## Translation ## Translation
* NewPipe can be translated on [weblate](https://hosted.weblate.org/projects/newpipe/strings/) * NewPipe can be translated on [weblate](https://hosted.weblate.org/projects/newpipe/strings/)
## Issue reporting ## Code contribution
* Search the [existing issues](https://github.com/theScrabi/NewPipe/issues) first to make sure your issue hasn't been reported before * Follow the [Google Style Guidelines](https://google.github.io/styleguide/javaguide.html)
* Check if this issue is already fixed in the repository * Make changes on a separate branch, not on the master branch (Featurebranching)
* When making bug reports, be sure to tell which version of NewPipe you are using and the steps to reproduce the problem * When submitting changes, you agree that your code will be licensed under GPLv3
* Please include a log if you can * Please test your code bevore you submit changes!!!
## Communication ## Communication
* For the time being, [Slack](https://newpipe.slack.com/) is being used for project communication. Ask [me](https://github.com/theScrabi) to sign up. * I hereby declare our Slack channel as dead!!! There are no plans on building a new chat, but if there is interest on creating one and ceeping it alive, I'd be pleased to create one again.
* If you want to get in contact with me or one of our other contrebutors you can send me an email at tnp(at)schabi.org
* Feel free to post suggestions, changes, ideas etc! * Feel free to post suggestions, changes, ideas etc!