mirror of
https://github.com/PrivateBin/PrivateBin.git
synced 2026-04-23 22:34:47 -04:00
Merge pull request #1804 from PrivateBin/docs/contrib-guide
Strengthen AI guidlines & enforce screenshots for visual changes
This commit is contained in:
@@ -6,3 +6,10 @@ Have a look at our [contributing guide](https://github.com/PrivateBin/PrivateBin
|
||||
If you want to translate PrivateBin into your language have a look at the [translation guide](https://github.com/PrivateBin/PrivateBin/wiki/Translation).
|
||||
|
||||
Except this also opening [issues](https://github.com/PrivateBin/PrivateBin/issues) helps much. Just describe your problem detailed enough and fill out our template.
|
||||
|
||||
## Guidelines for pull requests
|
||||
|
||||
Please note that we, as per our pull request template, **require users to disclose the use of an AI/LLM tool**. We would be glad about details such as the exact used tool/relevant chat snippets or a full (link to the) chat conversation. In any case, please take care to manually test and review your pull request.
|
||||
|
||||
For Frontend adjustments or other changes visible visually in the PrivateBin web UI, please _always_ attach at least **a screenshot** of how it looks like with your changes applied. You may only omit that for invisible changes or _very_ obvious little changes like fixing typographic mistakes or translations etc.
|
||||
If possible, especially for bigger or interactive changes, please also attach a link to a working test instance.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<!-- This is a template for your Pull Request. This are just some suggestions for you. You do not have to use all of them. -->
|
||||
<!--Please honor our guidelines as written in the CONTRIBUTING.md file. To emphasize: it is required to disclose the usage of an LLM tool. -->
|
||||
|
||||
<!-- If your PR fixes an issue, mention it here. You can also just copy the URL - GitHub will convert it for you.
|
||||
If this PR fixes several issues, please prepend each issue url/number with the word "fix"/"fixes" or "close"/"closes" as this automatically closes the issues you mentioned when the PR is merged.
|
||||
@@ -6,11 +6,12 @@ If this PR fixes several issues, please prepend each issue url/number with the w
|
||||
This PR fixes
|
||||
|
||||
## Changes
|
||||
<!-- List all the changes you have done -->
|
||||
<!-- List all the changes you have done. This section is just an example and may be removed if irrelevant. -->
|
||||
*
|
||||
*
|
||||
|
||||
## ToDo
|
||||
<!-- This section is just an example and may be removed if irrelevant, e.g. if you have completely implemented the PR. -->
|
||||
* [ ]
|
||||
* [ ]
|
||||
* [ ]
|
||||
|
||||
Reference in New Issue
Block a user