Peertube
/
NewPipe-app-android
mirror of https://github.com/TeamNewPipe/NewPipe/
1
0
Fork 0
Code Issues Releases Wiki Activity
NewPipe-app-android/.github/CONTRIBUTING.md

66 lines
4.7 KiB
Markdown
Raw Normal View History

update contribution guidelines
2016-09-27 13:43:43 +02:00
NewPipe contribution guidelines
===============================
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
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.
2017-08-02 23:34:46 +02:00
PLEASE READ THESE GUIDELINES CAREFULLY BEFORE ANY CONTRIBUTION!
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
update contribution guidelines once again
2016-09-27 14:14:59 +02:00
## Crash reporting
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
update contribution guidelines
2018-12-01 09:21:57 +01: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 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.
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
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.
2017-08-02 23:34:46 +02:00
## Issue reporting/feature requests
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
update contribution guidelines
2018-12-01 09:21:57 +01:00
* Search the [existing issues](https://github.com/TeamNewPipe/NewPipe/issues) first to make sure your issue/feature
update contributing.md
2020-04-04 12:10:54 +02:00
hasn't been reported/requested before.
* Check whether your issue/feature is already fixed/implemented.
* Check if the issue still exists in the latest release/beta version.
* If you are an Android/Java developer, you are always welcome to fix an issue or implement a feature yourself. PRs welcome!
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.
2017-08-02 23:34:46 +02:00
* We use English for development. Issues in other languages will be closed and ignored.
add sigle issue signle thread rule
2017-09-19 19:21:20 +02:00
* Please only add *one* issue at a time. Do not put multiple issues into one thread.
update contributing.md
2020-04-04 12:10:54 +02:00
* Follow the template! Issues or feature requests not matching the template might be closed.
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
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.
2017-08-02 23:34:46 +02:00
## Bug Fixing
update contribution guidelines
2018-12-01 09:21:57 +01:00
* 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
Update .github/CONTRIBUTING.md Co-Authored-By: Tobias Groza <TobiGr@users.noreply.github.com>
2020-04-04 12:28:20 +02:00
<a href="mailto:tnp@newpipe.schabi.org">tnp@newpipe.schabi.org</a> to let us know that you intend to help. We'll send you further instructions. You may, on request,
update contributing.md
2020-04-04 12:10:54 +02:00
register at our [Sentry](https://sentry.schabi.org) instance (see section "Crash reporting" for more information).
Update CONTRIBUTING.md
2017-02-12 00:16:41 +01:00
update resources names to match naming convention & cleanup & start working on themes
2016-01-05 20:56:40 +01:00
## Translation
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
update contributing.md
2020-04-04 12:10:54 +02:00
* NewPipe is translated via [Weblate](https://hosted.weblate.org/projects/newpipe/strings/). You can log in there
update contribution guidelines
2018-12-01 09:21:57 +01:00
with your GitHub account.
update contributing.md
2020-04-04 12:10:54 +02:00
* If the language you want to translate is not on Weblate, you can add it: see [How to add a new language](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-add-a-new-language-to-NewPipe) in the wiki.
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
update contribution guidelines
2016-09-27 13:43:43 +02:00
## Code contribution
Update and rename contributing.md to CONTRIBUTING.md
2015-12-23 09:31:11 +01:00
Add need for contributors to discuss possible changes This was discussed in IRC, and should help prevent the occurrence of problems where people spend hours on a feature only for it to be rejected for miscellaneous reasons.
2020-08-14 18:27:06 +02:00
* If you want to add a feature or change one, please open an issue describing your change. This gives the team and community a chance to give feedback before you spend any time on something that could be done differently or not done at all. It also prevents two contributors from working on the same thing and one being disappointed when only one user's code can be added.
update contributing.md
2020-04-04 12:10:54 +02:00
* Stick to NewPipe's style conventions: follow [checkStyle](https://github.com/checkstyle/checkstyle). It will run each time you build the project.
* Do not bring non-free software (e.g. binary blobs) into the project. Also, make sure you do not introduce Google
update contribution guidelines
2018-12-01 09:21:57 +01:00
libraries.
Update .github/CONTRIBUTING.md Co-Authored-By: Tobias Groza <TobiGr@users.noreply.github.com>
2020-04-04 12:28:20 +02:00
* Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy).
* Make changes on a separate branch with a meaningful name, not on the master neither dev branch. This is commonly known as *feature branch workflow*. You
update contributing.md
2020-04-04 12:10:54 +02:00
may then send your changes as a pull request (PR) on GitHub.
update contribution guidelines
2018-12-01 09:21:57 +01:00
* 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! Ideally, provide test feedback in the PR
description. Untested code will **not** be merged!
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.
2017-08-02 23:34:46 +02:00
* Try to figure out yourself why builds on our CI fail.
update contribution guidelines
2018-12-01 09:21:57 +01:00
* 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,
update contributing.md
2020-04-04 12:10:54 +02:00
but if not, you are asked to rebase the dev branch manually and resolve the problems on your own. You can find help [on the wiki](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-merge-a-PR). That will make the
update contribution guidelines
2018-12-01 09:21:57 +01:00
maintainers' jobs way easier.
* 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 submission, or clearly state that in the description of your PR.
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.
2017-08-02 23:34:46 +02:00
* Respond yourselves if someone requests changes or otherwise raises issues about your PRs.
update contribution guidelines
2018-12-01 09:21:57 +01:00
* Send PR that only cover one specific issue/solution/bug. Do not send PRs that are huge and consists of multiple
independent solutions.
Update and rename contributing.md to CONTRIBUTING.md
2015-12-23 09:31:11 +01:00
Add contribution guidelines Contribution guidelines are a helpful way to inform new potential contributors about the way in which they can help with the project. It's also a helpful way to enforce some consistent coding style and quality among the contributions.
2015-12-22 16:14:56 +01:00
## Communication
update contribution guidelines
2018-12-01 09:21:57 +01:00
* 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)!
* If you want to get in touch with the core team or one of our other contributors you can send an email to
update contributing.md
2020-04-04 12:10:54 +02:00
<a href="mailto:tnp@newpipe.schabi.org">tnp@newpipe.schabi.org</a>. Please do not send issue reports, they will be ignored and remain unanswered! Use the GitHub issue
update contribution guidelines
2018-12-01 09:21:57 +01:00
tracker described above!
update contributing.md
2020-04-04 12:10:54 +02:00
* Feel free to post suggestions, changes, ideas etc. on GitHub or IRC!