Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.79 KB

CONTRIBUTE.md

File metadata and controls

51 lines (37 loc) · 1.79 KB

Contributing to FStick

Welcome to FStick Project! Before you get started, please take a moment to read the following guidelines.

How to Contribute

  1. Fork the Repository:

    • Click on the "Fork" button at the top right corner of the repository's page on GitHub.
    • Clone your forked repository to your local machine: 
      git clone https://github.com/IMXNOOBX/fstick

  2. Create a New Branch:

    • Create a new branch for your changes: 
      git checkout -b develop/your-feature-or-fix

  3. Make Changes:

    • Make your changes and ensure that your code follows the project's coding standards.

  4. Describe Your Changes:

    • Clearly describe the purpose of your changes in the commit message.
    • If you are fixing a bug, provide information about the issue and how your changes address it.

  5. Push Changes:

    • Push your changes to your fork: 
      git push origin develop/your-feature-or-fix

  6. Create a Pull Request (PR):

    • Go to the FStick repository on GitHub.
    • Click on the "New Pull Request" button.
    • Select your branch and provide a descriptive title and summary of your changes.

Bug Reports

If you are reporting a bug, please provide the following information:

  • Version: Specify the version of the software.
  • Source: Mention whether you downloaded the software or built it from source.
  • Device: Specify the device/platform where the software is running.
  • Logs: Include any relevant logs or crash information with the Serial Monitor.

Code of Conduct

The project is single threaded to create a challenge for myself, if you have any good reason to make it multi-threaded, please let me know. If not please keep it single threaded to keep the challenge.

Thank you for contributing to FStick! 🚀