Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 1.91 KB

Contributing to SmartShreds

Thank you for considering contributing to SmartShreds! By contributing to this open-source project, you agree to abide by the Code of Conduct.

Ways to Contribute

There are several ways you can contribute to SmartShreds:

  1. Reporting Bugs:

    • Help identify bugs and issues by reporting them. Use the issue tracker to report bugs.
  2. Suggesting Enhancements:

    • Have ideas for new features or improvements? Share your suggestions through the issue tracker.
  3. 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.

Getting Started

To contribute to SmartShreds, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
    git clone https://github.com/JKomieter/SmartShreds.git
  3. Create a Branch for your changes.
    git checkout -b feature/YourFeatureName
  4. Make Changes to the codebase.
  5. Test your changes locally.
  6. Commit your changes and provide a descriptive commit message.
    git commit -am 'Add feature: Describe your changes'
  7. Push your changes to your forked repository.
    git push origin feature/YourFeatureName
  8. Submit a Pull Request (PR) to the main branch of the original repository.

Code Style

  • Follow the existing code style and conventions used in the project.

Code Review

  • All contributions go through code review. Be prepared to iterate on your code based on feedback.

License

By contributing to SmartShreds, you agree that your contributions will be licensed under the Apache License.

Acknowledgements

We appreciate your contributions to making SmartShreds better! Thank you for your help in improving this project.