-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to zig-esp-idf-sample | ||
|
||
Thank you for considering contributing to [zig-esp-idf-sample](https://github.com/kassane/zig-esp-idf-sample)! | ||
|
||
## How Can You Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug, please report it by opening an issue in the [Issues](https://github.com/kassane/zig-esp-idf-sample/issues) section. Please include: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the bug. | ||
- Steps to reproduce the bug. | ||
- Any relevant log output. | ||
|
||
### Suggesting Enhancements | ||
|
||
Enhancement suggestions are welcome. Please submit a detailed proposal in the [Issues](https://github.com/kassane/zig-esp-idf-sample/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. | ||
|
||
### Submitting Pull Requests | ||
|
||
1. **Fork the Repository**: Click on the "Fork" button at the top right of the repository page. | ||
2. **Clone Your Fork**: | ||
```sh | ||
git clone https://github.com/your-username/zig-esp-idf-sample.git | ||
``` | ||
3. **Create a Branch**: | ||
```sh | ||
git checkout -b feature/your-feature-name | ||
``` | ||
4. **Make Changes**: Implement your changes in the new branch. | ||
5. **Commit Changes**: | ||
```sh | ||
git commit -m "Description of the feature or fix" | ||
``` | ||
6. **Push to Your Fork**: | ||
```sh | ||
git push origin feature/your-feature-name | ||
``` | ||
7. **Create a Pull Request**: Go to the original repository and click on "Compare & pull request". Fill out the necessary information and submit. | ||
|
||
### Code Style | ||
|
||
Please ensure your code follows these guidelines: | ||
|
||
- See [Zig - Style Guide](https://ziglang.org/documentation/0.12.0/#Style-Guide) | ||
- Include comments and documentation as necessary. | ||
- Write tests for new features and bug fixes where applicable. |