OPGman's Contributing Guidelines

Thanks for contributing! Before you start, please read through the following guidelines. Be sure to also check the readme of the repo you're contributing to for any additional guidelines or restrictions. Most of these are not strictly enforced, but not following them might increase the chances of your submission being rejected or ignored.

Note About AI

I do not accept issues or code that are written in whole or in part by generative AI. Please do your own work and proofread before submitting. If I have reason to believe that any part of your submission violates this rule, it will be rejected without further discussion.

Issues

• Make your report as detailed as possible. Include both a description of the issue and, if possible, a list of steps to reproduce it.
• Your report should be written in coherent English.
• Verify that the issue you're having hasn't been reported already.
• Make a separate report for each issue you have.
• I will also accept non-issues such as feature requests or questions as long as they are relevant to the repo.

Pull Requests

• Keep your pull requests simple and directed towards a single change. If you want to change or add multiple unrelated things, make separate pull requests for each of them.
• Any large changes you plan on making should be discussed with me ahead of time, to make sure it's something I'll accept and also not something that's already being working on.
• Use conventional programming methods. Try to avoid doing unusual things that might leave me or others confused, and add comments next to or above any code that might be confusing.
• Try to keep your formatting consistent with what's already written for the sake of readability.
• Optimize your code as much as possible, but prioritize readability over micro-optimizations.
• Make sure everything works properly before submitting the PR. I will test it myself before accepting, but having it work the first time makes it easier for both of us.