Developer's Guide

Public Documentation

This is a guide for developing the patch library. Documentation for how to use this library is available on HexDocs

Getting Started

This project is a standard Mix Project, simply clone it to your local machine to begin developing the project. The bulk of the logic of this project is in the patch.ex file.

Testing Standards

Any new feature or bugfix should be accompanied with appropriate test coverage.

Any new function exposed by use Patch should have a test case added to the User Suite

Running the tests

To run the tests simply issue

mix test

Documentation Standards

New features should have both @doc blocks and a section in the README which serves as the end-user guidebook.

Cutting a new Release

To cut a new release of the library, follow these steps.

0. Make sure the Github Actions are all passing.
1. Create a new branch named release/{version}.
2. Bump the version in mix.exs, this project uses SemVer 2.0
3. Update the changelog with a short summary and the relevant standard sections for each release. 0.Minor and Major version releases require a Breaking Changes section, even if it only reports "None."
4. Commit the resulting files.
5. Open a PR.
6. Review and Merge the PR.
7. Run mix hex.publish
8. Add a git tag with the format v{version}
9. Celebrate