be-gay-do-crimes
/
NewPipe
mirror of https://github.com/TeamNewPipe/NewPipe
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix bugs in CONTRIBUTING.md 

Spelling and grammar bugs, a few additions here and there, make it sound like a team project instead of a one-man show.
This commit is contained in:
TheAssassin 2017-08-02 23:34:46 +02:00 committed by GitHub
parent 27e5ce7f9b
commit 9e2ed10144
1 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
.github/CONTRIBUTING.md vendored
View File

@ -1,40 +1,42 @@
NewPipe contribution guidelines NewPipe contribution guidelines
=============================== ===============================
READ THIS GUIDELINES CAREFULLY BEFORE CONTRIBUTING. PLEASE READ THESE GUIDELINES CAREFULLY BEFORE ANY CONTRIBUTION!
## Crash reporting ## Crash reporting
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 occurs. Do not report crashes in the GitHub issue tracker. NewPipe has an automated crash report system that will ask you to send a report via e-mail when a crash occurs. This contains all the data we need for debugging, and allows you to even add a comment to it. You'll see exactly what is sent, the system is 100% transparent.
## Issue reporting/feature request ## Issue reporting/feature requests
* Search the [existing issues](https://github.com/theScrabi/NewPipe/issues) first to make sure your issue/feature hasn't been reported/requested before * Search the [existing issues](https://github.com/TeamNewPipe/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 * Check whether your issue/feature is already fixed/implemented
* If you are an android/java developer you are always welcome to fix/implement an issue/a feature yourself * If you are an Android/Java developer, you are always welcome to fix/implement an issue/a feature yourself. PRs welcome!
* Use english * We use English for development. Issues in other languages will be closed and ignored.
## Bugfixing ## Bug Fixing
* 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://sentry.schabi.org) setup. * If you want to help NewPipe to become free of bugs (this is our utopic goal for NewPipe), you can send us an email to tnp@newpipe.schabi.org to let me know that you intend to help. We'll send you further instructions. You may, on request, register at our [Sentry](https://sentry.schabi.org) instance (see section "Crash reporting" for more information.
## Translation ## Translation
* NewPipe can be translated on [weblate](https://hosted.weblate.org/projects/newpipe/strings/) * NewPipe can be translated via [Weblate](https://hosted.weblate.org/projects/newpipe/strings/). You can log in there with your GitHub account.
## Code contribution ## Code contribution
* Stick to NewPipe style guidelines (just look the other code and than do it the same way :) ) * Stick to NewPipe's style conventions (well, just look the other code and then do it the same way :))
* Do not bring nonfree software/binary blobs into the project (keep it google free) * Do not bring non-free software (e.g., binary blobs) into the project. Also, make sure you do not introduce Google libraries.
* Stick to [f-droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy) * 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) * Make changes on a separate branch, not on the master branch. This is commonly known as *feature branch workflow*. You may then send your
* When submitting changes, you agree that your code will be licensed under GPLv3 * When submitting changes, you confirm that your code is licensed under the terms of the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).
* Please test (compile and run) your code before you submit changes!!! * Please test (compile and run) your code before you submit changes! Ideally, provide test feedback in the PR description. Untested code will **not** be merged!
* Try to figure out you selves why CI fails, or why a merge request collides * Try to figure out yourself why builds on our CI fail.
* Please maintain your code after you contributed it. * Make sure your PR is up-to-date with the rest of the code. Often, a simple click on "Update branch" will do the job, but if not, you are asked to merge the master branch manually and resolve the problems on your own. That will make the maintainers' jobs way easier.
* Respond yourselves if someone request changes or notifies issues * Please show intention to maintain your features and code after you contributed it. Unmaintained code is a hassle for the core developers, and just adds work. If you do not intend to maintain features you contributed, please think again about sumission, or clearly state that in the description of your PR.
* Respond yourselves if someone requests changes or otherwise raises issues about your PRs.
## Communication ## Communication
* WE DO NOW HAVE A MAILING LIST: [newpipe@list.schabi.org](https://list.schabi.org/cgi-bin/mailman/listinfo/newpipe). * WE DO NOW HAVE A MAILING LIST: [newpipe@list.schabi.org](https://list.schabi.org/cgi-bin/mailman/listinfo/newpipe).
* 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 * There is an IRC channel on Freenode which is regularly visited by the core team and other developers: [#newpipe](irc:irc.freenode.net/newpipe). [Click here for Webchat](https://webchat.freenode.net/?channels=newpipe)!
* Feel free to post suggestions, changes, ideas etc! * If you want to get in touch with the core team or one of our other contributors you can send an email to tnp(at)schabi.org. Please do not send issue reports, they will be ignored and remain unanswered! Use the GitHub issue tracker described above!
* Feel free to post suggestions, changes, ideas etc. on GitHub, IRC or the mailing list!