Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 2.17 KB

Contribution Guidelines

Thank you for your interest in improving ArduinoStrike! This project grows stronger with each contribution, and whether it’s fixing an issue or suggesting a new idea, your help makes a big difference. Here’s how you can contribute:

How You Can Help

  • Report Bugs: If you find an error or a bug, please create a new issue on GitHub with a detailed description.
  • Suggest Improvements: If you have ideas on how to enhance the project, feel free to open a discussion or issue to suggest them.
  • Share Your Code: If you’ve solved a problem or added a new feature, share it with the community by creating a Pull Request (PR).
  • Spread the Word: The more people who know about this project, the better! Share it with friends who might want to contribute or use it.

Creating an Issue or Pull Request

  1. Be Friendly and Open to Different Ideas

    • ArduinoStrike is a community space for everyone interested in improving the project, so let’s keep the environment respectful and welcoming.

  2. Use Code Blocks

    • When including code, use code blocks for readability. For longer snippets (30+ lines), please use a GitHub gist instead.

  3. Choose Clear Titles

    • Titles should be brief and to the point, capturing the essence of the issue or change.

  4. Provide Details

    • When describing a problem, please include:
      • A clear description of the issue
      • Code snippets if applicable
      • Information on your setup (e.g., Arduino model, library version)

Submitting a Pull Request

  1. Fork the Repository: Create a copy of the project in your account.
  2. Create a Separate Branch: Name it after the change, e.g., fix-recoil-bug or add-feature.
  3. Make Your Changes: Write clean, understandable code.
  4. Test Your Code: Ensure it works as expected.
  5. Submit the PR: Make a pull request and, in the description, explain what you changed and why it’s beneficial.

Thank you for helping to improve ArduinoStrike! Your contribution is truly appreciated.