diff --git a/.github/workflows/initial-setup.yml b/.github/workflows/initial-setup.yml index 836f8e3..b761dc2 100644 --- a/.github/workflows/initial-setup.yml +++ b/.github/workflows/initial-setup.yml @@ -32,6 +32,12 @@ jobs: # Rename _README.md to README.md mv _README.md README.md + + # Delete the template logo placeholder + rm -f docs/resources/images/maya_python_logo.png + + # Rename template logo + mv docs/resources/images/_maya_python_logo.png docs/resources/images/maya_python_logo.png - name: Set up Python uses: actions/setup-python@v5 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5c0cd7..a4e9a56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,18 +42,21 @@ ## Contributing 1. Fork the Project. 2. Create your Feature Branch (`git checkout -b feature_name`). -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`). +3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`). 4. Push to the Branch (`git push origin feature_name`). 5. Open a Pull Request. ### Commit Messages: -This project uses [Python Semantic Release](https://python-semantic-release.readthedocs.io/en/latest/). When committing changes, please follow the [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) to ensure your changes are correctly versioned in any future releases. +This project (optionally) uses [Python Semantic Release](https://python-semantic-release.readthedocs.io/en/latest/). To use this feature, please follow the [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) to ensure changes are correctly versioned in any future releases. Cheat sheet: -- `fix`: Patch release, backwards-compatible bug fix _in git commit message title_. -- `feat`: Minor release, backwards-compatible feature _in git commit message title_. -- `BREAKING CHANGE`: Major release, incompatible API change _in git commit msg footer (use `fix` or `feat` for message title)_. +- Patch release, backwards-compatible bug `fix` _in git commit message title_, e.g. + - `git commit -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'`

(back to top)

@@ -61,7 +64,7 @@ Cheat sheet: ## Project Dependencies >

Update to reflect the new project's specific requirements!

-> The below instructions assume a virtual environment created from mayapy is being used for the project, with , +> The below instructions assume a virtual environment created from mayapy is being used for the project, > for more info see: https://help.autodesk.com/view/MAYACRE/ENU/?guid=GUID-6AF99E9C-1473-481E-A144-357577A53717.

Project dependencies are available in the [requirements.in](requirements.in) file, which should be compiled with [pip-tools](https://github.com/jazzband/pip-tools). diff --git a/docs/resources/images/_maya_python_logo.png b/docs/resources/images/_maya_python_logo.png new file mode 100644 index 0000000..00c5658 Binary files /dev/null and b/docs/resources/images/_maya_python_logo.png differ