Please add a `CONTRIBUTING.md`

Rudxain commented 2 years ago

This is useful for many reasons, specially the code style and formatting. There's no need to strictly adhere to a standard, since a lot of things may be context-dependent, but explaining some context examples would be helpful for contributors and maintainers, because development performance can (and will) increase because there's less questions to ask and less pattern recognition to do (also the cognitive load of remembering the patterns is decreased)

I've seen:

Files indented with tabs, 2 spaces, and 4 spaces
Use of single and double quotes at the same line with no explanation of why they're inconsistent and no pattern to find
Some places have semicolons and other's don't. Although I found the pattern: they're only used when a line delimitation is ambiguous (this is good practice)
Some functions are one-liners and others get expanded to 3 lines, seemingly with no pattern or context
let and const used interchangeably, with a bias in favor of let. I like this because let is shorter, but it unnecessarily increases cognitive load when a variable is never assigned to, causing both humans and compilers to check if the variable is read-only or not

This causes confusion for people that want to contribute for the 1st or 2nd time to the repo (if they actually think or notice these details lol)

The file can also give other kinds of advice to increase the likelihood and speed of a PR being accepted

asdfd3v commented 2 years ago

this isnt an issue :/

GDColon commented 2 years ago

i'm gonna be honest, haven't been paying too much attention to this repo because i wanna archive it and rewrite the site from the ground up. it's pretty much beyond saving, and my goal is to make a new version thats 100% client side, with the exception of a cors proxy for raw requests

Rudxain commented 2 years ago

@GDColon I don't know if it's a good idea to archive and create a different website, but if you have thought about this more than me then I guess you know what's best. You could make a poll, or ask users about different ways to solve this situation. Brainstorming may be helpful

Rudxain commented 2 years ago

@asdfd3v but why? I understand most of the things I said are "minor things" but I also said "advice for PRs". A contributing.md isn't limited to style and formatting, it's much more than that, we should look at what other repos put in that file

asdfd3v commented 2 years ago

i mean its not an issue. its not like not having a "Contributing.md" file is gonna ruin or break GDBrowser. Nor is it gonna be any trouble to anyone.

Rudxain commented 2 years ago

it's not an issue

I know and you're right, but the Issues Tab in GH can be used for stuff that isn't just bugs and feature requests. It can be for meta stuff like the proposal I made. The name "Issues" is misleading, but I got used to it lol

GDColon / GDBrowser

Please add a `CONTRIBUTING.md` #245