Contributing.md

Contributing to Bagshui

Here’s how you can get involved and help make Bagshui better!

Bug reports and feature requests

• Bugs are tracked here.
• Feature requests can be submitted through discussions.

Code changes

All changes happen through pull requests

Please follow Github Flow. TL;DR:

1. Fork the repo and create a new branch from main.
   • If you have collaborator access, you don’t need to fork, but you do need to create a new branch.
2. Make changes.
3. Create a pull request.

Please try to follow existing coding style

• Indent using tabs, not spaces (I know, I know).
• Comments that explain the why of the code, not just the what.
  • Use LuaCATS-style function comments.
• No semicolons at end of lines.
• Avoid collapsing if statements into one-liners.
  ^{Don’t do this: if true then return end.}
• Split long lines (including conditions and function calls).
  ^{Try not to go too far past column 120.}

License

You agree that your contributions will be under the MIT License.