From 9d7184d86ed80365bb7f90baef46598fd89b7794 Mon Sep 17 00:00:00 2001 From: Sekwah Date: Fri, 14 May 2021 11:42:46 +0100 Subject: [PATCH] docs: Updated README.md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b08c364..0994903 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,29 @@ Usage stats can be found here https://bstats.org/plugin/bukkit/AdvancedPortals The api isn't implemented in this version, sorry for any inconvenience. Check the recode tree for possibly a working recode at some point. -## Contributing +# Contributing Please ensure that your commits are in the following style for PR's https://www.conventionalcommits.org/en/v1.0.0/ -This will help with changelogs and tracking bugfixes. +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) +