Skip to content

update contributing with examples, replace the template logo #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/initial-setup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,29 @@
## 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'`


<p align="right">(<a href="#readme-top">back to top</a>)</p>


## Project Dependencies
> <h4>Update to reflect the new project's specific requirements!<br><br>
> 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.</h4>

Project dependencies are available in the [requirements.in](requirements.in) file, which should be compiled with [pip-tools](https://github.com/jazzband/pip-tools).
Expand Down
Binary file added docs/resources/images/_maya_python_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.