The functions are ordered in groups according to what they do, and the groups
are signified in the source code using C99 // ... // line comments. The
following groups exist:
- Initialization
- Querying
- Modification
- Concatenation
- Freeing
- Low-level functions
Note: the Concatenation group technically belongs to the Modification group, but they were split out due to the amount of them.
A commit message should have a short, roughly 50 characters or shorter summary describing what was done in the commit. The summary is optionally followed by a longer description of the changes and reasons for them after a blank line, and wrapped at around 72 characters.
If the commit fixes a bug that has been previously reported, include a line
like Fixes #123 in the commit message. When the commit is merged it will
cause the issue to automatically be closed. See the GitHub help page on
Closing issues via commit messages for a list of all keywords.
All commits contributed should also contain a sign-off line to show that you accept the Developer Certificate of Origin. Add a sign-off line by adding a line like the following to the end of each of your commit messages:
Signed-off-by: Random J Developer <random@developer.example.org>
References: A Note About Git Commit Messages
First of all note that this is a style guide and not hard-set rules.
Lines should preferably be under 80 if possible, but longer lines are allowed or even encouraged if either necessary or if it makes the code nicer and cleaner.
All source code is indented using tabs and aligned with spaces. A tab is counted as 4 characters when determining the length of a line.
By sending in a contribution through opening a GitHub pull request you agree to license your contribution under the 2-clause BSD license.