Thank you for considering contributing to zig-esp-idf-sample!
If you find a bug, please report it by opening an issue in the Issues section. Please include:
- A clear and descriptive title.
- A detailed description of the bug.
- Steps to reproduce the bug.
- Any relevant log output.
Enhancement suggestions are welcome. Please submit a detailed proposal in the Issues section, including:
- A clear and descriptive title.
- A detailed description of the proposed enhancement.
- The rationale for the enhancement.
- Examples of how the enhancement would be useful.
- Fork the Repository: Click on the "Fork" button at the top right of the repository page.
- Clone Your Fork:
git clone https://github.com/your-username/zig-esp-idf-sample.git
- Create a Branch:
git checkout -b feature/your-feature-name
- Make Changes: Implement your changes in the new branch.
- Commit Changes:
git commit -m "Description of the feature or fix" - Push to Your Fork:
git push origin feature/your-feature-name
- Create a Pull Request: Go to the original repository and click on "Compare & pull request". Fill out the necessary information and submit.
Please ensure your code follows these guidelines:
- See Zig - Style Guide
- Include comments and documentation as necessary.
- Write tests for new features and bug fixes where applicable.