Merge pull request #4 from mattdeform/updates-to-ci-and-contributing

pre-release update

Author: mattdeform

.github/workflows/ci-release.yml

@@ -10,21 +10,20 @@ jobs:
     uses: ./.github/workflows/reusable-static-analysis.yml
 
   tests:
-    needs: static-analysis
     if: github.repository != 'mattdeform/MayaPythonProjectTemplate'
     uses: ./.github/workflows/reusable-maya-tests.yml
 
   do_release:
     if: github.repository != 'mattdeform/MayaPythonProjectTemplate'
-    needs: [static-analysis, tests]
+    needs: [tests]
     uses: ./.github/workflows/reusable-semantic-release.yml
     permissions:
       contents: write
       id-token: write
 
   docs:
     if: github.repository != 'mattdeform/MayaPythonProjectTemplate'
-    needs: [static-analysis, tests, do_release]  # only build docs when release is successful
+    needs: [tests, do_release]  # only build docs when release is successful
     uses: ./.github/workflows/reusable-build-and-deploy-docs.yml
     permissions:
       contents: write

.github/workflows/reusable-static-analysis.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint black mypy
+        pip install pylint mypy
 
     - name: Analysing the code with pylint
       run: |
@@ -36,7 +36,7 @@ jobs:
       uses: psf/black@stable
       with:
         src: "src"
-        options: "--check"
+        options: "--diff"
 
     - name: Analysing the code with mypy
       run: mypy src

CONTRIBUTING.md

@@ -51,12 +51,12 @@ This project (optionally) uses [Python Semantic Release](https://python-semantic
 
 Cheat sheet:
 
-- Patch release, backwards-compatible bug `fix` _in git commit message title_, e.g. 
-  - `git commit -m 'fix: a great fix'`
+- Patch release, backwards-compatible bug `fix` _in git commit message title_. 
+  - `git commit -a -m "fix: a great fix"`
 - Minor release, backwards-compatible `feat` _in git commit message title_.
-  - `git commit -m 'feat: Add some AmazingFeature'`
-- Major release, incompatible API change `BREAKING CHANGE` _in git commit msg footer (use `fix` or `feat` for message title)_.
-  - `git commit -m 'feat: Add some AmazingFeature\n\nBREAKING CHANGE'`
+  - `git commit -a -m "feat: a wonderful new feature"`
+- Major release, incompatible API change `BREAKING CHANGE` _in git commit message footer (use `fix` or `feat` for message title)_.
+  - `git commit -a -m "feat: total refactor" -m "BREAKING CHANGE: breaks api"`
 
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>

README.md

@@ -16,15 +16,14 @@
 <h3 align="center">Maya Python Project Template</h3>
 
   <p align="center">
-    A GitHub template for Maya Python tools.
-    <br />
+    A GitHub template for Maya Python tools by <a href="https://www.techartops.com">TechArtOps</a>.<br>
     <a href="https://github.com/mattdeform/MayaPythonProjectTemplate/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
     ·
     <a href="https://github.com/mattdeform/MayaPythonProjectTemplate/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
   </p>
 </div>
 
-
+> Example project built using this template can be found [here](https://github.com/mattdeform/locator_creator). 
 
 ## HOW TO USE THIS TEMPLATE
 
@@ -39,20 +38,20 @@
 
 ## What is included in this template?
 * Basic project structure.
-* [README.md](_README.md) template.
-* [CONTRIBUTING.md](CONTRIBUTING.md) template.
+* [README.md](_README) and [CONTRIBUTING](CONTRIBUTING.md) templates.
 * Bug report and feature request templates.
 * Continuous integration using [GitHub Actions][github-actions-url] with jobs to:
-  * [Run tests](.github/workflows/reusable-maya-tests.yml) in containerized Maya. `Note: User should hold a valid Maya license.`
+  * [Run integration tests](.github/workflows/reusable-maya-tests.yml) across a range of Maya versions in isolated Docker containers. 
+    * `Note: You should hold a valid Maya license.`
   * [Enforce coding standards](.github/workflows/reusable-static-analysis.yml) with [pylint](https://pypi.org/project/pylint/), [black](https://github.com/psf/black), and [mypy](https://mypy.readthedocs.io/en/stable/).
   * [Build and deploy documentation](.github/workflows/reusable-build-and-deploy-docs.yml) to GitHub pages with [mkdocs](https://www.mkdocs.org/).
-  * [Make versioned releases](.github/workflows/ci-release.yml) using python semantic versioning.
+  * [Automated releases](.github/workflows/ci-release.yml) using Python Semantic Versioning (optional).
 
 
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
 * This project uses Docker images courtesy of [mottosso/docker-maya](https://github.com/mottosso/docker-maya).
-* Inspiration taken from both 
+* Inspiration taken from both:
   * [python-project-template](https://github.com/rochacbruno/python-project-template/tree/main).
   * [Best-README-Template](https://github.com/othneildrew/Best-README-Template).
 

_README.md

@@ -154,9 +154,9 @@ Please reach out via the [request a feature](https://github.com/{{PROJECT_OWNER}
 
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
+* Project template by [TechArtOps](https://www.techartops.com).
 * foo
 * bar
-* baz
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>