Advanced-Portals/README.md
2024-11-18 05:46:15 +00:00

3.2 KiB

Advanced portals

Discord

Advanced Portals

An advanced portals plugin designed to have a wide range of features which are easy to use. It adds a bunch of commands to create and edit portals and destinations.

Usage

Check out the Tutorial, List of Commands, and List of Portal Tags.

Download

Contributing

Please ensure that your commits are in the following style for PR's

https://www.conventionalcommits.org/en/v1.0.0/

Also if you could, please run pre-commit run --files ... or pre-commit run --all-files to ensure that the code is formatted correctly. You will need to have clang-format installed for this to work.

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

The scopes available should be the specific modules being worked on. E.g. core, spigot, docs

Documentation

That is handled on the website branch.

At some point I may merge this onto this branch to try to push for documentation changes with new features, though for now this works.