|
3 | 3 | NewPipe contribution guidelines |
4 | 4 | =============================== |
5 | 5 |
|
| 6 | +## AI policy |
| 7 | + |
| 8 | +* Using generative AI to develop new features or making larger code changes is generally prohibited. Please refrain from contributions which are heavily depending on AI generated source code because they are usually lacking a fundamental understanding of the overall project structure and thus come with poor quality. However, you are allowed to use gen. AI if you |
| 9 | + * are aware of the project structure, |
| 10 | + * ensure that the generated code follows the project structure, |
| 11 | + * fully understand the generated code, and |
| 12 | + * review the generated code completely. |
| 13 | +* Using AI to find the root cause of bugs and generating small fixes might be acceptable. However, gen. AI often does not fix the underlying problem but is trying to fix the symptoms. If you are using AI to fix bugs, ensure that the root cause is tackled. |
| 14 | +* The use of AI to generate documentation is allowed. We ask you to thoroughly check the quality of generated documentation – wrong, misleading or uninformative documentation is useless and wastes the reader's time. Ensure that reasoning is documented. |
| 15 | +* Using generative AI to write or fill in PR or issue templates is prohibited. Those texts are foten lengthy and miss critical information. |
| 16 | +* PRs aynd issues that do not follow this AI policy can be closed without further explanation. |
| 17 | + |
| 18 | + |
6 | 19 | ## Crash reporting |
7 | 20 |
|
8 | 21 | Report crashes through the **automated crash report system** of NewPipe. |
@@ -42,17 +55,6 @@ You'll see *exactly* what is sent, be able to add **your comments**, and then se |
42 | 55 | * Create PRs that cover only **one specific issue/solution/bug**. Do not create PRs that are huge monoliths and could have been split into multiple independent contributions. |
43 | 56 | * NewPipe uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to fetch data from services. If you need to change something there, you must test your changes in NewPipe. Telling NewPipe to use your extractor version can be accomplished by editing the `app/build.gradle` file: the comments under the "NewPipe libraries" section of `dependencies` will help you out. |
44 | 57 |
|
45 | | -### Use of generative AI |
46 | | - |
47 | | -* Using generative AI to develop new features or making larger code changes is generally prohibited. Please refrain from contributions which are heavily depending on AI generated source code because they are usually lacking a fundamental understanding of the overall project structure and thus come with poor quality. However, you are allowed to use gen. AI if you |
48 | | - * are aware of the project structure, |
49 | | - * ensure that the generated code follows the project structure, |
50 | | - * fully understand the generated code, and |
51 | | - * review the generated code completely. |
52 | | -* Using AI to find the root cause of bugs and generating small fixes might be acceptable. However, gen. AI often does not fix the underlying problem but is trying to fix the symptoms. If you are using AI to fix bugs, ensure that the root cause is tackled. |
53 | | -* The use of AI to generate documentation is allowed. We ask you to thoroughly check the quality of generated documentation – wrong, misleading or uninformative documentation is useless and wastes the reader's time. Ensure that reasoning is documented. |
54 | | -* PRs that do not follow this AI policy can be closed without further explanation. |
55 | | - |
56 | 58 | ### Creating a Pull Request (PR) |
57 | 59 |
|
58 | 60 | * Make changes on a **separate branch** with a meaningful name, not on the _master_ branch or the _dev_ branch. This is commonly known as *feature branch workflow*. You may then send your changes as a pull request (PR) on GitHub. |
|
0 commit comments