Thank you for considering contributing to OSIM!
Your contributions help improve the project for everyone.
The following is a set of guidelines for contributing to OSIM project. Feel free to propose changes to this document in a pull request.
Please read the OSIM Developer Guide first for general overview on the project ecosystem, practices and configuration.
If you would like to contribute to OSIM project, please follow these steps:
-
Fork the repository: Click the "Fork" button at the top right of the repository's page on GitHub to create your own copy of the repository.
-
Clone your fork: Clone the repository to your local machine using the following command, replacing
[your-username]with your GitHub username.git clone https://github.com/[your-username]/osim.git
-
Create a new branch: Create a new branch for your changes using a descriptive name.
git checkout -b feature/new-feature
-
Commit your changes: Commit your changes with a clear and descriptive commit message.
git commit -am 'Add new feature' -
Push your changes: Push your changes to your fork of the repository
git push origin feature/new-feature
-
Open a Pull Request: Visit the repository on GitHub and open a new pull request. Provide a clear title and description for your pull request as defined in the following Pull Request template:
## Checklist:
- [ ] Linting passed
- [ ] Type checks passed
- [ ] Tests suite passed
- [ ] Commits consolidated
- [ ] Changelog updated
- [ ] Test cases added/updated
## Summary:
[Replace with a brief summary of the changes introduced by this PR.]
## Changes:
[Replace with a detailed description of the changes made in this PR, including any new features, enhancements, bug fixes, or refactorings.]
## Considerations:
[Replace with any additional considerations, notes, or instructions for reviewers.]
If you need help or have questions about contributing to OSIM, please open an issue on the issue tracker. We'll be happy to assist you!
Thank you for contributing to OSIM!