-
-
Notifications
You must be signed in to change notification settings - Fork 17
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
1 parent
2c50b9d
commit 0edbb91
Showing
2 changed files
with
48 additions
and
1 deletion.
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,47 @@ | ||
# Contributing to This Project | ||
|
||
Thank you for your interest in contributing! This document outlines the process for contributing to our project. | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository | ||
2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` | ||
3. Make your changes | ||
4. Test your changes thoroughly | ||
5. Commit your changes with clear, descriptive commit messages | ||
6. Push to your fork | ||
7. Submit a Pull Request | ||
|
||
## Pull Request Guidelines | ||
|
||
- Ensure your PR addresses a specific issue or adds value to the project | ||
- Include a clear description of the changes | ||
- Keep changes focused and atomic | ||
- Follow existing code style and conventions | ||
- Include tests if applicable | ||
- Update documentation as needed | ||
|
||
## Code Style | ||
|
||
- Follow the existing code formatting in the project (ensure you have Biome installed) | ||
- Write clear, self-documenting code | ||
- Add comments only when necessary to explain complex logic | ||
- Use meaningful variable and function names | ||
|
||
## Reporting Issues | ||
|
||
- Use the GitHub issue tracker | ||
- Check if the issue already exists before creating a new one | ||
- Provide a clear description of the issue | ||
- Include steps to reproduce if applicable | ||
- Add relevant labels | ||
|
||
## Questions or Need Help? | ||
|
||
Feel free to open an issue for questions or join our discussions. We're here to help! | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code. | ||
|
||
Thank you for contributing! |
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