Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
index 95683a9..193d5b0 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,34 @@ will automatically build the project and proxy all calls to the local build dire
./test/bin/pkgctl --help
```
+### Commit messages
+
+All commits must follow [conventional commits](https://www.conventionalcommits.org).
+
+The following groups are allowed:
+
+- chore
+- feat
+- fix
+- doc
+- perf
+- test
+
+To override the scope for the changelog entry use the `Component:` trailer.
+
+Example:
+
+```
+feat(db): yay mega cool feature
+
+Very long and useful description.
+
+Fixes #1
+Fixes #2
+
+Component: pkgctl db remove
+```
+
## Releasing
1. bump the version in the Makefile
@@ -41,7 +69,9 @@ will automatically build the project and proxy all calls to the local build dire
- bash
- binutils
- coreutils
+- curl
- diffutils
+- fakeroot
- findutils
- grep
- jq
@@ -57,6 +87,12 @@ will automatically build the project and proxy all calls to the local build dire
- mercurial
- subversion
+### Optional Dependencies
+
+- bat (pretty printing)
+- nvchecker (version checking)
+- pacman-contrib (--update-checksums options for pkgctl build)
+
### Development Dependencies
- asciidoc