diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..f9bdad7c8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +## Summary + + + +This PR adds.. + +## Related Issues + + + +Related # + +Closes # + +## Changes + + + +- List changes here + +## Checklist + +I confirm that I have: + +- [ ] **Followed the + [Conventional Commits](https://www.conventionalcommits.org/) + specification** (e.g., `feat: add new feature`, `fix: correct bug`, + `docs: update documentation`). +- [ ] **My PR title also follows the conventional commits specification.** +- [ ] **Updated relevant documentation,** if necessary. +- [ ] **Thoroughly tested my changes.** +- [ ] **Added tests** (if applicable) and verified existing tests pass with + `make test`. +- [ ] **Checked for breaking changes** and documented them, if any. diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..4610fa923 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,19 @@ +on: + push: + branches: + - master + +permissions: + contents: write + pull-requests: write + +name: release-please + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: googleapis/release-please-action@v4 + with: + token: ${{ secrets.GH_TOKEN }} + release-type: simple diff --git a/docs/contributing.org b/docs/contributing.org index a8c548588..44ee5a22d 100644 --- a/docs/contributing.org +++ b/docs/contributing.org @@ -96,3 +96,9 @@ make test FILE=./tests/plenary/api/api_spec.lua :CUSTOM_ID: parser :END: Parsing is done via builtin treesitter parser and the [[https://github.com/milisims/tree-sitter-org][tree-sitter-org]] grammar. + +**** Commits +:PROPERTIES: +:CUSTOM_ID: commits +:END: +Ensure that you follow the [[https://www.conventionalcommits.org/][Conventional Commits]] specification (e.g., =feat: add new feature=, =fix: correct bug=, =docs: update documentation=).