Contributing Code

This guide describes how you can contribute code to EPUBCheck.

§ Commit guidelines

We’ve adopted precise rules over how out Git commit messages must be formatted, known as the Angular commit message format. This format allows us to automatically generate the changelog, and make the commit history easy to read.

If you do not want to follow these guidelines, for one reason or another, no problem! We will rewrite your commit history (using git rebase -i) when merging your contribution to the master branch.

§ Pull requests

To contribute new code or bug fixes, please submit a pull request. Please refer to the Github documentation about pull requests if you’re not familiar with the concept.

§ Git Branches

At this time we do not have established branching strategy or naming conventions. A contribution is considered finalized when it is merged to the master branch.