OPGman's Contributing Guidelines

Thanks for being interested in contributing! Before you start, please read through the following guidelines. These apply to all of my repos, so they're pretty generic. Please be sure to also check the readme of the repo you're contributing to for any additional guidelines or restrictions.

Note that these are guidelines and not rules. You don't have to follow each and every one of them, but I would appreciate it if you did. The only times I will outright reject a submission is if it looks like you went out of your way to not follow any of the guidelines, or the submission violates my policy on AI, which is described below.

AI Policy

When you submit an issue or pull request, I expect you to fully understand the content you're submitting. I don't care if you use AI as a tool to help you write something, but it shouldn't be obvious that you did so. If I can tell that most of what you submitted was written by an AI, I'm going to assume that you don't know what you're doing, and your submission 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, unless they're all closely related.
• I will also accept non-issues such as feature requests and 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. In most cases I will test it myself before accepting, but having it work the first time makes it easier for both of us.