I had this idea a while ago (about a year), of making my own little set of guidelines for when it comes to me committing/opening PRs or issues/etc, not because I needed them or anything, but because I wanted to provide something for others to see how I like contributing and stuff. Also because I'd like to give some kind of "baseline" that others can then inspire their own contributing guidelines and stuff from.
First of all, what I refer to as my "setup", is just a pretty simple description of my dev environment. Second, I put this out just for others to see how I do stuff, not as a "hey roast my stuff". I don't care what distro you use, what editor you use, what compiler do you prefer; this is my setup.
All issues and PRs' titles are labeled at the start with one of the following tags:
And as far as issue/PR etiquette goes, just try to pack as much info into one message/comment, nobody likes having 4 emails from Github because you can't edit a message or attach a video. Also, all issues/PRs (and commits) have to end with "I hope you explode", regardless of context.
Look, I don't want my contrib graph looking like a fucking bathroom, so I might as well just send one big commit with a lot of code at once, I don't care if I'm gonna have to spend 1 hour of my time fixing merge conflicts or doing code review, I'm not spamming commits for every single change I make.
Going along with that entire "one commit > 100 small commits" thing, I always try to explain everything that my gigant commit does in detail via a git comment, I know its odd but at least I'm not throwing a PR called "ehkwrjguhlvrgthugtrjlite" and having the maintainers guess what it does by reading the code.
I try to make comments only when necessary (ex, code is fucking spaghetti), and even when I do, I'm gonna be humourist about it. All I'm gonna say about this is that comments aren't really something I enjoy being formal about as it's one of those things that don't really matter unless I'm trying to make some kind of glossary to look back in the future, which even then, I'm gonna be really informal about. And most developers won't even see them so I honestly don't care about them.
I tend to always sign my commits, you can get a hold of my GPG and SSH keys over at my about page. Now, my GPG key may only have 2 emails listed (kris@memeware.net and citizensixtynine@protonmail.com), but in reality I use it for more than just those 2 emails. Here is the list that I hereby approve that I use with this GPG key:
Oh and Github's pre-generated key thing from the Web UI/Desktop Client is also approved. And may I add that all my Gitlab/Codeberg commits will always be signed with this key, if you see a commit of mine not signed with this key under these platforms, contact me about it.
This should be about it when it comes to my entire "contributing guidelines etiquette" endeavours, I'll update this as time goes on but that should be about it.
