Styleguide

Contains information on restrictions to how things should be added to this project:

Commit Message restrictions

Git Hooks enforce commit message restrictions. The hook requires that commit messages follow the format: <prefix>(optional-scope): <description>. Where the prefix is determined using the prefix-list script file.

Branch Name restrictions

Git Hooks also enforce that branch names match a similar syntax. The style must follow: <prefix>/<hyphenated-description> where the prefix is determined by the same prefix-list script file.

PR Title restrictions

Pull Requests Titles are enforced by a GitHub Action. PRs against develop must have a title that starts with <prefix>: where the the prefix matches the branch prefix. PRs against main must have a title release-* or patch-*

GitHub Release Note contents

The GitHub Release Notes are created by the main-on-merge GitHub Action. This action builds the releases notes from the commit messages, using only commit messages that match the defined prefixes.

Ideas

• PR Message Linting?
• Code Formatting/Linting
• Best Practices for Code Design/Architecture/Components?