Developer Commit Guidelines

Understanding what our commit prefixes mean

Developers, please follow these commit guidelines closely. We like polished code, but we love clean and precise commit names.

Users, you can tag along this article to understand how we label changes.


Commit Descriptions

This goes without saying; ALWAYS add a changelog, or decent explanation of changes, in the commit description.

Example of a good and bad commit description. For fairness, here's a mediocre commit description.

For clarification: Just because a commit description isn't a changelog doesn't mean it'll get rejected in a PR. You can always add the changelog to the PR. Additionally, a "decent" explanation can often be "a whole lotta try catching" when adding a lot of try{something}catch{error} to, for example, an API route.


General Guidelines

These are used for standard commits


Smaller Commit Types

These are usually only used by the Team for "on-the-fly" changes


Documentation hosted on GitHub Pages. Contribute Directly on GitHub. Made with Ɛ> by The Hydraulisc Team, proof-read, maintained and fact checked by our incredible Contributors.

Site made with a modified version of the Catppuccin mocha theme.

The Catppuccin themes and the Catppuccin mocha theme are licenced under the MIT License, which allows for Public, Private and Commercial Use, Distribution, and Modification.