Skip to content

Commit

Permalink
chore: Update CONTRIBUTING.md guide
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverswitzer committed Dec 3, 2024
1 parent b8483ba commit 0d73a04
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
* 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)

0 comments on commit 0d73a04

Please sign in to comment.