diff --git a/README.md b/README.md index ff98c14b..280c661a 100644 --- a/README.md +++ b/README.md @@ -70,3 +70,25 @@ Scopes are only needed if relating to specific features just to make them easier _I'll expand the list as I work more on the project._ * **proxy** (Proxy specific features and issues) +https://www.conventionalcommits.org/en/v1.0.0/ + +Accepted tags mostly follow the Angular style and are meant to only loosely be followed. +When commits close an issue refer in the commit description in the following style (Refs #1, #2, #3) +## Types available +* **build**: Changes that affect the build system or external dependencies +* **ci**: Changes to our CI configuration files and scripts +* **docs**: Documentation only changes +* **feat**: A new feature +* **fix**: A bug fix +* **perf**: A code change that improves performance +* **refactor**: A code change that neither fixes a bug nor adds a feature +* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) + + +## Scopes available +Scopes are only needed if relating to specific features just to make them easier to find. +_I'll expand the list as I work more on the project._ +* **proxy** (Proxy specific features and issues)