Merge pull request #38 from python-thread/dev

Formatting, documentation and CI improvements

Author: caffeine-addictt

.github/CODESTYLE.md

@@ -57,21 +57,27 @@ class ExampleClass:
 
 
 ## Commit Message Guidelines
-When committing, commit messages are prefixed with a `+` or `-`. Depending on the type of change made 
-influences which prefix is used.
-
- - `+` when something is added.
- - `-` when something is removed.
- - none: when neither is applicable, like merge commits.
+When committing, commit messages are prefixed with one of the following depending on the type of change made.
+
+ - `feat:` when a new feature is introduced with the changes.
+ - `fix:` when a bug fix has occurred.
+ - `chore:` for changes that do not relate to a fix or feature and do not modify *source* or *tests*. (like updating dependencies)
+ - `refactor:` for refactoring code that neither fixes a bug nor adds a feature.
+ - `docs:` when changes are made to documentation.
+ - `style:` when changes that do not affect the code, but modify formatting.
+ - `test:` when changes to tests are made.
+ - `perf:` for changes that improve performance.
+ - `ci:` for changes that affect CI.
+ - `build:` for changes that affect the build system or external dependencies.
+ - `revert:` when reverting changes.
 
 Commit messages are also to begin with an uppercase character. Below list some example commit messages.
 
+```sh
+git commit -m "docs: Added README.md"
+git commit -m "revert: Removed README.md"
+git commit -m "docs: Moved README.md"
 ```
-git commit -m "+ Added README.md"
-git commit -m "- Removed README.md"
-git commit -m "Moved README.md"
-```
-
 
 
 ## Markdown Guidelines

.github/ISSUE_TEMPLATE/8-version-checklist.md

@@ -0,0 +1,14 @@
+---
+name: "vX.X.X: Version Release Checklist"
+about: "Checklist for version release"
+labels: "Documentation"
+assignees: caffeine-addictt
+
+---
+
+# Version Release Checklist
+
+- [ ] I have updated the README.md file
+- [ ] I have ensured that all tests pass
+- [ ] I have incremented the version number in `__init__.py`
+- [ ] I have incremented the version number in `pyproject.toml`

.github/release-drafter.yml

@@ -0,0 +1,40 @@
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+template: |
+  # What's Changed
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
+
+categories:
+  - title: "New"
+    label: "Type: Feature"
+
+  - title: "Bug Fixes"
+    label: "Type: Bug"
+
+  - title: "Improvements"
+    label: "Type: Enhancement"
+
+  - title: "Other changes"
+
+  - title: "Documentation"
+    label: "Documentation"
+    collapse-after: 5
+
+version-resolver:
+  major:
+    labels:
+      - "Type: Breaking"
+  minor:
+    labels:
+      - "Type: Feature"
+  patch:
+    labels:
+      - "Type: Bug"
+      - "Documentation"
+      - "Type: Security"
+
+exclude-labels:
+  - "Skip-Changelog"

.github/settings.yml

@@ -1,80 +1,88 @@
 labels:
-  - name: 'Type: Bug'
+  - name: "Type: Breaking"
+    color: a90000
+    description: A problem or enhancement related to a breaking change.
+
+  - name: "Type: Bug"
     color: e80c0c
     description: Something isn't working as expected.
 
-  - name: 'Type: Enhancement'
+  - name: "Type: Enhancement"
     color: 54b2ff
     description: Suggest an improvement for an existing feature.
 
-  - name: 'Type: Feature'
+  - name: "Type: Feature"
     color: 54b2ff
     description: Suggest a new feature.
 
-  - name: 'Type: Security'
+  - name: "Type: Security"
     color: fbff00
     description: A problem or enhancement related to a security issue.
 
-  - name: 'Type: Question'
+  - name: "Type: Question"
     color: 9309ab
     description: Request for information.
 
-  - name: 'Type: Test'
+  - name: "Type: Test"
     color: ce54e3
     description: A problem or enhancement related to a test.
 
-  - name: 'Status: Awaiting Review'
+  - name: "Status: Awaiting Review"
     color: 24d15d
     description: Ready for review.
 
-  - name: 'Status: WIP'
+  - name: "Status: WIP"
     color: 07b340
     description: Currently being worked on.
 
-  - name: 'Status: Waiting'
+  - name: "Status: Waiting"
     color: 38C968
     description: Waiting on something else to be ready.
 
-  - name: 'Status: Stale'
+  - name: "Status: Stale"
     color: 66b38a
     description: Has had no activity for some time.
 
-  - name: 'Duplicate'
+  - name: "Duplicate"
     color: EB862D
     description: Duplicate of another issue.
 
-  - name: 'Invalid'
+  - name: "Invalid"
     color: faef50
     description: This issue doesn't seem right.
 
-  - name: 'Priority: High +'
+  - name: "Priority: High +"
     color: ff008c
     description: Task is considered higher-priority.
 
-  - name: 'Priority: Low -'
+  - name: "Priority: Low -"
     color: 690a34
     description: Task is considered lower-priority.
 
-  - name: 'Documentation'
+  - name: "Documentation"
     color: 2fbceb
     description: An issue/change with the documentation.
 
   - name: "Won't fix"
     color: C8D9E6
     description: Reported issue is working as intended.
 
-  - name: '3rd party issue'
+  - name: "3rd party issue"
     color: e88707
     description: This issue might be caused by a 3rd party script/package/other reasons
 
-  - name: 'Os: Windows'
+  - name: "Os: Windows"
     color: AEB1C2
     description: Is Windows-specific
 
-  - name: 'Os: Mac'
+  - name: "Os: Mac"
     color: AEB1C2
     description: Is Mac-specific
 
-  - name: 'Os: Linux'
+  - name: "Os: Linux"
     color: AEB1C2
     description: Is Linux-specific
+
+  - name: "Skip-Changelog"
+    color: AEB1C2
+    description: Skip changelog in release tag

.github/workflows/draft-release-tag.yml

@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: read
+
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        with:
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}