Merge branch 'main' into share-magic-wormhole

OpenAdaptAI · Jun 29, 2023 · 088f370 · 088f370
2 parents 4c59c10 + 5ab0e01
commit 088f370
Show file tree

Hide file tree

Showing 15 changed files with 512 additions and 168 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,23 @@
+name: Semantic Release
+on:
+  push:
+    branches:
+      - main
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Python Semantic Release
+        id: semantic_release
+        uses: relekang/python-semantic-release@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          repository_username: __token__
+          repository_password: ${{ secrets.PYPI_TOKEN }}
+          git_committer_name: "OpenAdapt Bot"
+          git_committer_email: "[email protected]"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,6 +21,65 @@ To speed up the review process, please use the provided pull request template an
 
 The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documenttation.
 
+## Commit Message Format
+
+Each commit message consists of a **header**, a **body**, and a **footer**. The header has a special format that includes a **type**, a **scope**, and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory, and the **scope** of the header is optional. The commit message lines should not exceed 100 characters in length.
+
+### Type
+
+The type must be one of the following:
+
+- **feat**: A new feature
+  - Increments the minor version number (e.g., 1.0.0 -> 1.1.0)
+
+- **fix**: A bug fix
+  - Increments the patch version number (e.g., 1.0.0 -> 1.0.1)
+
+- **docs**: Documentation-only changes
+  - Does not affect the version number
+
+- **style**: Changes that do not affect the code's meaning (e.g., white-space, formatting)
+  - Does not affect the version number
+
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+  - Does not affect the version number
+
+- **perf**: A code change that improves performance
+  - Does not affect the version number
+
+- **test**: Adding missing or correcting existing tests
+  - Does not affect the version number
+
+- **chore**: Changes to the build process, auxiliary tools, or libraries
+  - Does not affect the version number
+
+### Scope
+
+The scope specifies the location of the commit change. For example: `db`, `crud`, `strategies`, `utils`, etc. Use `*` when the change affects more than a single scope.
+
+### Subject
+
+The subject should be a succinct description of the change. Please follow these guidelines:
+- Use the imperative, present tense (e.g., "change" not "changed" or "changes")
+- Do not capitalize the first letter
+- Do not end with a dot (.)
+
+### Body
+
+The body should provide the motivation for the change and contrast it with the previous behavior. Use the imperative, present tense (e.g., "change" not "changed" or "changes").
+
+The body or footer can begin with **BREAKING CHANGE:** followed by a short description to create a major release. For example, a major release would increment the version number from `0.1.0` to `1.1.0`.
+
 ## Submitting Changes
 
 1. Fork the current repository

diff --git a/README.md b/README.md
@@ -206,7 +206,7 @@ If you're interested in getting paid for your work, please mention it in your Pu
 
 MacOS: if you encounter system alert messages or find issues when making and replaying recordings, make sure to [set up permissions accordingly](./permissions_in_macOS.md).
 
-![MacOS System Alerts](./assets/macOS_permissions_alert.png)
+![MacOS System Alerts](https://github.com/MLDSAI/OpenAdapt/assets/43456930/dd96ab17-7cd6-4762-9c4f-5131b224a118)
 
 In summary (from https://stackoverflow.com/a/69673312):