Contributing

Conventions

Commits

• Rebase merge only--maintain a linear git history
• Use Conventional Commits for commit messages
• Avoid large, monolithic commits--prefer smaller commits that have an easy-to-understand scope/purpose

Code

Comments

• Use TODO and FIXME wherever applicable, being consistent with this makes it easy to find things to do/fix in the codebase
• Write comments (ideally laconic in nature) to explain anything that isn't immediately obvious from reading the code--tragic as it is, we aren't all mind readers

Style

• Consistent code style makes everyone's life easier--format your code and stick to the project's code style