Skip to content

Commit 2798d25

Browse files
author
Pierre BAILLET
committed
Add contribution doc
1 parent 43fc493 commit 2798d25

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,41 @@ In `cargo.toml`
1111
fsevent = "*"
1212
```
1313

14+
1415
# Usage
1516

1617
cf examples/ folder.
1718

19+
# Contributing
20+
21+
Contributions are welcome! Here's how you can help:
22+
23+
## Reporting Issues
24+
25+
If you find a bug or have a feature request, please open an issue on GitHub with:
26+
- A clear description of the problem or suggestion
27+
- Steps to reproduce (for bugs)
28+
- Expected vs actual behavior
29+
- Your environment details (OS version, Rust version)
30+
31+
## Pull Requests
32+
33+
1. Fork the repository
34+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
35+
3. Make your changes
36+
4. Run tests: `cargo test`
37+
5. Run clippy: `cargo clippy`
38+
6. Format your code: `cargo fmt`
39+
7. Commit your changes (`git commit -m 'Add some amazing feature'`)
40+
8. Push to your branch (`git push origin feature/amazing-feature`)
41+
9. Open a Pull Request
42+
43+
Please ensure:
44+
- All tests pass
45+
- Code follows Rust style guidelines (enforced by `rustfmt`)
46+
- New features include tests
47+
- Documentation is updated if needed
48+
1849
# Contributors
1950

2051
- Mathieu Poumeyrol [kali](https://github.com/kali)

0 commit comments

Comments
 (0)