2015-12-22 16:14:56 +01:00
|
|
|
#Contributing
|
|
|
|
|
|
|
|
|
|
This document contains guidelines on making contributions to NewPipe.
|
|
|
|
|
|
|
|
|
|
## Programming
|
|
|
|
|
|
|
|
|
|
* Follow the [Google Style Guidelines](https://google.github.io/styleguide/javaguide.html)
|
|
|
|
|
* Make a new feature on a seperate branch, not on the master branch
|
2015-12-23 09:31:11 +01:00
|
|
|
* Make a [pull request](https://github.com/theScrabi/NewPipe/pulls) if you're done with your changes
|
2015-12-22 16:14:56 +01:00
|
|
|
* When submitting changes, you agree that your code will be GPLv3 licensed
|
|
|
|
|
|
|
|
|
|
## Commit messages
|
|
|
|
|
|
|
|
|
|
* The subject line of your commit message shouldn't be longer than 72 characters
|
|
|
|
|
* Try to keep each line of your commit message 72 characters to ensure proper
|
|
|
|
|
compatibility with all git tools
|
|
|
|
|
* [This guide](http://chris.beams.io/posts/git-commit/) goes more in depth on what makes a good commit message
|
|
|
|
|
|
|
|
|
|
## Translating
|
|
|
|
|
|
|
|
|
|
* NewPipe can be translated on [weblate](https://hosted.weblate.org/projects/newpipe/strings/)
|
|
|
|
|
|
2015-12-23 09:31:11 +01:00
|
|
|
## Issue reporting
|
|
|
|
|
|
|
|
|
|
* Search the [existing issues](https://github.com/theScrabi/NewPipe/issues) first to make sure your issue hasn't been reported before
|
|
|
|
|
* Check if this issue is already fixed in the repository
|
|
|
|
|
* When making bug reports, be sure to tell which version of NewPipe you are using and the steps to reproduce the problem
|
|
|
|
|
* Please include a log if you can
|
|
|
|
|
|
2015-12-22 16:14:56 +01:00
|
|
|
## Communication
|
|
|
|
|
|
|
|
|
|
* For the time being, [Slack](http://invite.chschtsch.ml/) is being used for project communication
|
2015-12-23 09:31:11 +01:00
|
|
|
* Feel free to post suggestions, changes ideas etc!
|
