Thank you for considering contributing to SmartShreds! By contributing to this open-source project, you agree to abide by the Code of Conduct.
There are several ways you can contribute to SmartShreds:
-
Reporting Bugs:
- Help identify bugs and issues by reporting them. Use the issue tracker to report bugs.
-
Suggesting Enhancements:
- Have ideas for new features or improvements? Share your suggestions through the issue tracker.
-
Contributing Code:
- Contribute bug fixes, new features, or improvements by submitting pull requests. Before starting any work, please discuss the changes you wish to make through an issue.
To contribute to SmartShreds, follow these steps:
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
git clone https://github.com/JKomieter/SmartShreds.git
- Create a Branch for your changes.
git checkout -b feature/YourFeatureName
- Make Changes to the codebase.
- Test your changes locally.
- Commit your changes and provide a descriptive commit message.
git commit -am 'Add feature: Describe your changes'
- Push your changes to your forked repository.
git push origin feature/YourFeatureName
- Submit a Pull Request (PR) to the
main
branch of the original repository.
- Follow the existing code style and conventions used in the project.
- All contributions go through code review. Be prepared to iterate on your code based on feedback.
By contributing to SmartShreds, you agree that your contributions will be licensed under the Apache License.
We appreciate your contributions to making SmartShreds better! Thank you for your help in improving this project.