Add contribution guidelines #4591
Draft
+230
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
absidue
reviewed
Apr 21, 2024
iBicha
reviewed
Apr 21, 2024
CONTRIBUTING.md
Outdated
| We use the [Github issue tracker](https://github.com/iv-org/invidious/issues) to track and manage | ||
| bug reports, feature requests and improvements. | ||
|
|
||
| **Note: Before opening any kind of issue, make sure to search on the tracker |
There was a problem hiding this comment.
I would even add something along the lines of "If you spot a duplicate issue, feel free to point it out"
This can help with reducing duplicates, where users who create duplicates can close them when they are made aware of the original issue
iBicha
reviewed
Apr 21, 2024
iBicha
reviewed
Apr 21, 2024
TheFrenchGhosty
requested changes
Apr 21, 2024
CONTRIBUTING.md
Outdated
| Once you've filled the form with your instance's informations, your instance will be added to our | ||
| uptime monitor. From there, a probatory period of 30 days will start, to make sure that you can | ||
| keep your instance online and up to date. Finally, your instance will be added to the list. We'll | ||
| ask you to join our Matrix room, so that we can inform you of important updates and exchange with |
There was a problem hiding this comment.
Suggested change
| ask you to join our Matrix room, so that we can inform you of important updates and exchange with | |
| ask you to join our Matrix room, so that we can inform you of important updates, warn you in advance of security issues and exchange with |
syeopite
reviewed
Apr 25, 2024
| @@ -1 +0,0 @@ | |||
| https://hosted.weblate.org/projects/invidious/ | |||
There was a problem hiding this comment.
Is the TRANSLATION file not necessary for Weblate or Github?
There was a problem hiding this comment.
I double checked, and I couldn't find a mention of that a file in their documentation.
| **Make sure to redact secrets like your DB password and HMAC key first!!** | ||
|
|
||
|
|
||
| **Note: Security-related issues should be reported by e-mail at |
There was a problem hiding this comment.
I think this is fine for now but in the future we should probably be pointing this to a proper security policy at SECURITY.md
Co-authored-by: absidue <48293849+absidue@users.noreply.github.com>
Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Co-authored-by: Brahim Hadriche <brahim.hadriche@gmail.com>
SamantazFox
force-pushed
the
contributing-md
branch
from
9c05025
to
0b91dae
Compare
SamantazFox
force-pushed
the
contributing-md
branch
from
0b91dae
to
69e2f37
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As this was requested multiples times, here is a
CONTRIBUTING.mdfile to guide new contributors.