Welcome to this document! I am happy you are reading this, and I look forward to checking your code out!
If you haven't already, come join the ComfyBot server. If you're not having fun, come here for some inspiration!
Make sure you have tested every feature/command you plan to integrate and ensure it does not break old commands, and does not cause huge strain on resources.
Please send a GitHub Pull Request to ComfyBot with a clear list of what you've done (read more about pull requests). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Start reading our code and you'll get the hang of it. We optimize for readability:
- We indent using two spaces (soft tabs)
- We ALWAYS put spaces after list items and method parameters (
[1, 2, 3], not[1,2,3]), around operators (x += 1, notx+=1), and around hash arrows. - This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
Thanks, DistroByte, ComfyBot Author