Skip to main content

Contributing to Grinduino

We're excited that you're interested in contributing to Grinduino! This document outlines the process for contributing to our project and provides some guidelines to ensure a smooth collaboration.

Getting Started​

  1. Fork the repository on GitHub.
  2. Clone your fork locally:
git clone https://github.com/your-username/grinduino.git
  1. Create a branch for your changes:
git checkout -b feature/your-feature-name

How to Contribute​

  1. Check the Issues page for open tasks or bugs.
  2. If you have a new idea, open an issue to discuss it before starting work.
  3. Make your changes in your feature branch.
  4. Test your changes thoroughly.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your changes to your fork on GitHub.
  7. Open a pull request to the main repository.

Pull Request Process​

  1. Ensure your code adheres to the project's style guidelines.
  2. Update the README.md with details of changes, if applicable.
  3. Add any necessary documentation for new features.
  4. Your pull request will be reviewed by maintainers, who may request changes or ask questions.
  5. Once approved, your pull request will be merged.

Style Guidelines​

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary, especially for complex logic.
  • Write clear commit messages explaining the purpose of your changes.

License Information​

This project is licensed under the MIT License. This means:

  • You are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software.
  • The software is provided "as is", without warranty of any kind.
  • You must include the original copyright notice and the MIT License notice in any copy of the software/source.

By contributing to this project, you agree that your contributions will be licensed under the MIT License.