============

CONTRIBUTING

============

When contributing code, please follow these simple guidelines.

WRITING COMMITS

1. Always include a short description of the change in the commit message body,

   explaining why the change was made.

2. In the commit summary, prefix the affected module, if there is one

   specifically.

3. If assisted by a coding agent, affix a commit trailer like:

        Assisted-by: Codex:gpt-5.5

4. Look at existing commit messages to get an idea of the style.

5. In terms of the message content, if you're fixing something, a good format to

   follow is: (a) state the current problematic behavior, (b) state the new,

   improved behavior, and optionally (c) state how or why this specific solution

   was chosen. One paragraph each.

A properly formed git commit subject line should always be able to complete the

following sentence:

     If applied, this commit will _____

For example, the following message is well formed:

     ui: Add support for .gif files

In addition, it should be capitalized and *must not* include a period.

When it comes to formatting, here's a model git commit message[1]:

     Capitalized, short (50 chars or less) summary

     More detailed explanatory text, if necessary.  Wrap it to about 72

     characters or so.  In some contexts, the first line is treated as the

     subject of an email and the rest of the text as the body.  The blank

     line separating the summary from the body is critical (unless you omit

     the body entirely); tools like rebase can get confused if you run the

     two together.

     Write your commit message in the imperative: "Fix bug" and not "Fixed bug"

     or "Fixes bug."  This convention matches up with commit messages generated

     by commands like git merge and git revert.

     Further paragraphs come after blank lines.

     - Bullet points are okay, too.

     - Typically a hyphen or asterisk is used for the bullet, followed by a

       single space, with blank lines in between, but conventions vary here.

     - Use a hanging indent.

---

[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html