Advanced-Portals/README.md
2023-04-06 04:50:08 +01:00

1.6 KiB

Advanced portals

Need to write a new readme for this.

Also I will set up release please to work with the below types for pretty changelogs.

The re-code is based off a mix of the original version, and the original re-code that was abandoned see here.

There were no issues with this approach, though for a number of reasons outside of the codebase progress was not made fast enough.

Contributing

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

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

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.