chore: Update CONTRIBUTING docs

* Tweak github ci sed command to update version in README.md
mechanical-orchard · Dec 2, 2024 · afb4a79 · afb4a79
1 parent 7698d59
commit afb4a79
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -57,7 +57,7 @@ jobs:
 
           # Update version in mix.exs
           sed -i 's/version: ".*"/version: "'${RELEASE_VERSION#v}'"/g' mix.exs
-          sed -i 's/\{:shortcut_api_ex, "*"/\{:shortcut_api_ex, "'${RELEASE_VERSION#v}'"/g' README.md
+          sed -i 's/\{:shortcut_api_ex, ".*"\}/\{:shortcut_api_ex, "'"${RELEASE_VERSION#v}"'"\}/g' README.md
           git add mix.exs
           git commit -m "chore: Bump version to ${RELEASE_VERSION}"
           git push origin $BRANCH_NAME

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,8 @@
+# Contributing
+
+## 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.
 
 ## Publishing a new commit