CONTRIBUTING.md - Buzruk.GenericRepository
We appreciate your interest in contributing to Buzruk.GenericRepository! This document outlines how you can contribute to the project and ensure a smooth collaboration process.
How to Contribute
There are several ways you can contribute to Buzruk.GenericRepository:
- Bug Reports: If you encounter a bug, please create a new issue on GitHub. Be sure to provide a clear description of the bug, including steps to reproduce it if possible.
- Feature Requests: Do you have an idea for a new feature? Feel free to create a new issue and share your proposal. Explain the problem your feature addresses and how it can benefit the project.
- Code Pull Requests: We welcome pull requests for bug fixes, improvements, and new features. Before submitting a pull request, please:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Implement your changes and write unit tests for them (if applicable).
- Ensure your code follows the project's coding style guidelines (if any).
- Open a pull request and provide a clear description of your changes.
- Documentation: If you find any errors or have suggestions for improving the documentation, please create an issue or submit a pull request with your proposed changes.
Coding Style
We recommend following consistent coding style throughout the project. If you're unsure about the preferred style, you can use tools like editorconfig to format your code.
Unit Tests
We encourage writing unit tests for your contributions. This helps ensure the quality and maintainability of the code.
Communication
We use GitHub issues for tracking bugs, features, and pull requests. Feel free to leave comments and questions on existing issues or create new ones for discussions.
License
This project is licensed under the MIT License. Please see the LICENSE.txt file for details.
Additional Resources
We are grateful for your contributions! Let's work together to make Buzruk.GenericRepository even better.