Upstream/Advanced-Portals
1
0
Fork 0
mirror of https://github.com/sekwah41/Advanced-Portals.git synced 2024-11-25 12:06:17 +01:00
Code Issues Projects Releases Wiki Activity

docs: Updated README.md

Browse Source
This commit is contained in:
Sekwah 2021-05-14 11:42:46 +01:00
parent 6b097087a2
commit 9d7184d86e
No known key found for this signature in database
GPG Key ID: C3BE2E6C861A461A
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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)
<!---
We don't currently do tests. But in case.
* **test**: Adding missing tests or correcting existing tests
-->
## 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)