Skip to content

Commit f6e5ae3

Browse files
committed
Enhance CONTRIBUTING.md with detailed guidelines
Added a new Contribution Guidelines section to the `CONTRIBUTING.md` file, including subsections for Getting Started, Code Style, Pull Requests, Testing, Code Reviews, Reporting Issues, and Community Standards. These updates aim to provide clear instructions for contributors, promote best practices, and foster a welcoming and inclusive community. Concluded with a note of appreciation for contributors' efforts. #79
1 parent 8860316 commit f6e5ae3

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contribution Guidelines
2+
3+
Thank you for your interest in contributing to this Blazor project! Please follow these guidelines to help us maintain a high-quality codebase.
4+
5+
## Getting Started
6+
7+
- Ensure you have [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0) installed.
8+
- Clone the repository and create a new branch for your feature or bugfix.
9+
- Run the project locally to verify your changes.
10+
11+
## Code Style
12+
13+
- Follow the [Microsoft C# Coding Conventions](https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions).
14+
- Use meaningful commit messages.
15+
- Keep code clean and well-documented.
16+
- For Blazor components, use `.razor` files and prefer component-based design.
17+
18+
## Pull Requests
19+
20+
- Fork the repository and submit your pull request from a feature branch.
21+
- Describe your changes clearly in the pull request description.
22+
- Reference related issues if applicable (e.g., `Fixes #123`).
23+
- Ensure your code builds and passes all tests before submitting.
24+
25+
## Testing
26+
27+
- Add or update unit and integration tests as appropriate.
28+
- Run all tests locally before submitting your pull request.
29+
30+
## Code Reviews
31+
32+
- Be responsive to feedback and make requested changes promptly.
33+
- Review other contributions when possible.
34+
35+
## Reporting Issues
36+
37+
- Use the issue tracker to report bugs or request features.
38+
- Provide clear steps to reproduce bugs and include relevant logs or screenshots.
39+
40+
## Community Standards
41+
42+
- Be respectful and inclusive.
43+
- Follow the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
44+
45+
Thank you for helping make this project better!

0 commit comments

Comments
 (0)