
* feat: bootstrap release please
* docs: add instruction to install a tag/release via tpm
* chore: add `tmux.conf` placeholder for bug template
* docs: add CONTRIBUTING.md
Copied from 3fdc011242/CONTRIBUTING.md
* refactor: change vlatest to latest
* docs: remove merge instructions
* docs: use full version as tag msg
1.4 KiB
1.4 KiB
Contributing
Adding a module
Follow the instructions from custom, place the module in the appropriate
directory and document the module in README.md
.
Commit messages
This repository uses Conventional Commits. Commit headers should be lowercase. Most commits should include a body that briefly describes the motivation and content of the commit.
Commit types
fix
: A bug fix that doesn't modify the public APIfeat
: A code change that modifies the public APIrefactor
: A code change that doesn't change behaviorstyle
: A style fix or changedocs
: Any change to documentationci
: Any change to CI filesrevert
: A revert commit. The message should describe the reasoning and the commit should include theRefs:
footer with the short hashes of the commits being reverted.chore
: catch-all type
Commit scopes
Available commit scopes are module names, status
, pane
, and
window
. If none of these apply, omit the scope.
Breaking changes
All breaking changes should be documented in the commit footer in the format
described by Conventional Commits. Use the <type>!
syntax in order to distinguish
breaking commits in the log, but include the footer to provide a better description
for the changelog generator.
feat(bar)!: foo the bars
BREAKING CHANGE: bars are now foo'ed