Add contribution guidelines #4591

SamantazFox · 2024-04-21T16:08:56Z

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

CONTRIBUTING.md

iBicha · 2024-04-21T16:56:19Z

CONTRIBUTING.md

+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


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

Co-authored-by: absidue <48293849+absidue@users.noreply.github.com>

CONTRIBUTING.md

iBicha · 2024-04-21T17:07:08Z

CONTRIBUTING.md

+
+
+
+## Testing


I think it is worth mentioning the labeling system. For example if I'm in for a round of testing, I can go to PRs, filter by need-testing and have at it. Perhaps as a contributor can comment something like "I'm testing this using this scenario..." so you know which PRs are in testing

You're right, thanks :)

TheFrenchGhosty

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

TheFrenchGhosty · 2024-04-21T16:58:52Z

CONTRIBUTING.md

+opened (and/or closed).**
+
+In order for everyone to be able to understand eachother, all exchanges are done in English.
+You can obviously use a translator if needed.


Suggested change

You can obviously use a translator if needed.

You can obviously use a translator if needed, though it is strongly encouraged that you speak a bit of English, since nuance will get lost in translation..

TheFrenchGhosty · 2024-04-21T17:00:25Z

CONTRIBUTING.md

+## Issues
+
+We use the [Github issue tracker](https://github.com/iv-org/invidious/issues) to track and manage
+bug reports, feature requests and improvements.


Suggested change

bug reports, feature requests and improvements.

bug reports, feature requests and improvements.

Users who (understandably) do not wish to use GitHub can [contact us](https://invidious.io/contact/) saying that they want us to open an issue for them (if you can write something we can directly paste in a GitHub issue, it would be perfect).

It's something I always did.

TheFrenchGhosty · 2024-04-21T17:01:58Z

CONTRIBUTING.md

+Before opening your issue, **make sure to test a few other instances**, just to check that the
+problem you're facing is not temporary (E.g an overloaded instance, a network outage, etc.) or
+caused by configuration error on your side.
+
+If a bug report already exists for your problem, you can add a comment with more details, but make
+sure that it's useful and adds value to the discussion. If 20 people did that already, it might not
+be relevant to post a new comment.


Move this above "you should open a "bug report"

CONTRIBUTING.md

TheFrenchGhosty · 2024-04-21T17:10:45Z

CONTRIBUTING.md

+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


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

TheFrenchGhosty · 2024-04-21T17:11:32Z

CONTRIBUTING.md

+wget "https://github.com/iv-org/invidious/pull/4439.diff"
+git apply 4439.diff


Can be done in another way by passing the URL directly to git apply (not sure of the syntax though)

Edit: found it in my notes:

git apply <(curl https://patch-diff.githubusercontent.com/raw/iv-org/invidious/pull/1403.patch)

using patch-diff is better by the way, pull/XXX.diff is often outdated.

The short URL (github.com) just 301 redirects to the long one, so it's the same, except the short one is easier to remember and type.

"Patch" includes each commit separately, with message info and other overhead, where as "Diff" is the entire code change without commit information. It's pretty much the same in the end, git apply doesn't really care.

The thing is that at one point pull/XX.diff was outdated but patch-diff wasn't, it's maybe solved but patch-diff was always correctly updated... so it seems safer to recommend its use.

Alternatively,

git fetch upstream pull/4591/head:branchname git checkout branchname

TheFrenchGhosty · 2024-04-21T17:12:04Z

CONTRIBUTING.md

+If you have prior knowledge of Invidious, that's great, but otherwise feel free to get in touch
+with us on Matrix or IRC. We'll do our best to give you a better understanding of the project.


"otherwise"?

No, they should join anyway.

TheFrenchGhosty · 2024-04-21T17:12:58Z

CONTRIBUTING.md

+Code contributions are handled through
+[Github's Pull Requests (PRs)](https://github.com/iv-org/invidious/pulls).
+
+Invidious' backend is developped in Crystal, a compiled language inspired from Ruby. The frontend


Suggested change

Invidious' backend is developped in Crystal, a compiled language inspired from Ruby. The frontend

Invidious' backend is developped in [Crystal](https://crystal-lang.org/), a compiled language inspired by Ruby. The frontend

TheFrenchGhosty · 2024-04-21T17:13:18Z

CONTRIBUTING.md

+Invidious' backend is developped in Crystal, a compiled language inspired from Ruby. The frontend
+is developped using Crystal's own templating engine (ECR) with some vanilla JS and CSS.
+
+Invidious follows more or less closely the [Crystal coding convention]


Badly worded

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Co-authored-by: Brahim Hadriche <brahim.hadriche@gmail.com>

syeopite · 2024-04-25T20:59:36Z

TRANSLATION

@@ -1 +0,0 @@
-https://hosted.weblate.org/projects/invidious/


Is the TRANSLATION file not necessary for Weblate or Github?

syeopite · 2024-04-25T21:00:42Z

CONTRIBUTING.md

+    **Make sure to redact secrets like your DB password and HMAC key first!!**
+
+
+**Note: Security-related issues should be reported by e-mail at


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

Repo: Add CONTRIBUTING.md, remove TRANSLATION

f77aaea

SamantazFox requested a review from a team as a code owner April 21, 2024 16:08

SamantazFox requested review from unixfox and removed request for a team April 21, 2024 16:08

SamantazFox marked this pull request as draft April 21, 2024 16:12

absidue reviewed Apr 21, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

iBicha reviewed Apr 21, 2024

View reviewed changes

Apply suggestions from code review

48d207b

Co-authored-by: absidue <48293849+absidue@users.noreply.github.com>

iBicha reviewed Apr 21, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

iBicha reviewed Apr 21, 2024

View reviewed changes

TheFrenchGhosty requested changes Apr 21, 2024

View reviewed changes

Apply suggestions from code review

9c05025

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Co-authored-by: Brahim Hadriche <brahim.hadriche@gmail.com>

syeopite reviewed Apr 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add contribution guidelines #4591

Add contribution guidelines #4591

SamantazFox commented Apr 21, 2024

iBicha Apr 21, 2024

iBicha Apr 21, 2024

SamantazFox Apr 21, 2024

TheFrenchGhosty left a comment •

edited

TheFrenchGhosty Apr 21, 2024

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024

TheFrenchGhosty Apr 21, 2024 •

edited

SamantazFox Apr 21, 2024

TheFrenchGhosty Apr 21, 2024

syeopite Apr 25, 2024

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024

TheFrenchGhosty Apr 21, 2024

syeopite Apr 25, 2024

syeopite Apr 25, 2024

	You can obviously use a translator if needed.
	You can obviously use a translator if needed, though it is strongly encouraged that you speak a bit of English, since nuance will get lost in translation..

	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

		wget "https://github.com/iv-org/invidious/pull/4439.diff"
		git apply 4439.diff

		If you have prior knowledge of Invidious, that's great, but otherwise feel free to get in touch
		with us on Matrix or IRC. We'll do our best to give you a better understanding of the project.

	Invidious' backend is developped in Crystal, a compiled language inspired from Ruby. The frontend
	Invidious' backend is developped in [Crystal](https://crystal-lang.org/), a compiled language inspired by Ruby. The frontend

		Make sure to redact secrets like your DB password and HMAC key first!!


		**Note: Security-related issues should be reported by e-mail at

		@@ -1 +0,0 @@
		https://hosted.weblate.org/projects/invidious/

Add contribution guidelines #4591

Are you sure you want to change the base?

Add contribution guidelines #4591

Conversation

SamantazFox commented Apr 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheFrenchGhosty left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheFrenchGhosty Apr 21, 2024 • edited

Choose a reason for hiding this comment

TheFrenchGhosty Apr 21, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheFrenchGhosty Apr 21, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheFrenchGhosty Apr 21, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheFrenchGhosty left a comment •

edited

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024 •

edited

TheFrenchGhosty Apr 21, 2024 •

edited