Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution guidelines #4591

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

SamantazFox
Copy link
Member

As this was requested multiples times, here is a CONTRIBUTING.md file to guide new contributors.

@SamantazFox SamantazFox requested a review from a team as a code owner April 21, 2024 16:08
@SamantazFox SamantazFox requested review from unixfox and removed request for a team April 21, 2024 16:08
@SamantazFox SamantazFox marked this pull request as draft April 21, 2024 16:12
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@TheFrenchGhosty TheFrenchGhosty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+ do a pass with a spellchecker, I might not have caught everything by "hand".

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@@ -1 +0,0 @@
https://hosted.weblate.org/projects/invidious/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the TRANSLATION file not necessary for Weblate or Github?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants