From 0d73a047f65d130bd4f5341ad3f46d0f5792579b Mon Sep 17 00:00:00 2001 From: Oliver Switzer Date: Tue, 3 Dec 2024 11:47:02 -0500 Subject: [PATCH] chore: Update CONTRIBUTING.md guide --- CONTRIBUTING.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30a2ac0..a2547dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,19 @@ ## Use of aider for assistance -We use aider to help facilitate making new modules here. It uses conventional commits, which our auto semantic versioning in CI pairs with nicely. +We use [`aider`](https://aider.chat/) to help facilitate adding behavior to our API clients. `aider` uses conventional commits when it makes changes, which our auto semantic versioning in `ci.yml` pairs with nicely. ## Publishing a new commit -To publish a new version of this tool, run the github CI [publish.yml](.github/workflows/publish.yml). +To publish a new version of this tool: + +1. grab the latest git tag from main (list them with `git tag`) +2. run the github CI [publish.yml](.github/workflows/publish.yml), and pass the git tag version you want to publish. It will: -* Automatically create a new version based the conventional commits since your last release. -* Bump the version in the README.md and mix.exs file -* Create a github release for that version \ No newline at end of file +* Automatically create a github release for that git tag +* Bump the version in the mix.exs file +* Create a github release for that version + +Remember to update the README.md documentation with the latest version (manual, for now, due to technical dificulties getting this to auto update) \ No newline at end of file