-
Notifications
You must be signed in to change notification settings - Fork 0
Contribution Guidelines
We are excited to welcome contributors to our project that aims to build a distributed logging system implemented in Go. The following guidelines will help you contribute to the project efficiently.
The project aims to build a highly scalable logging system that can operate in distributed environments. We have chosen Go as the primary programming language for its high performance and efficient concurrency support.
Before starting to contribute, take a look at our issue tracker on GitHub to see if there are any outstanding issues that you can help us address. If you find something that interests you, please leave a comment indicating that you would like to work on it.
If you find any bugs or have any feature requests that are not already covered, feel free to add them to the issue tracker. We encourage users to create well-documented and detailed issues to make it easier for contributors to address them.
- Fork the repository
- Clone the forked repository on your local machine
- Create a new branch for your feature or bug fix
- Follow the Go coding style and conventions when writing your code
- Ensure code quality by including proper tests
- Document your code and changes comprehensively
- Push your branch to your forked repository
- Open a pull request to the main repository specifying the branch and any changes made
- Respond to any feedback provided by the maintainers
- Once your pull request is approved, your contribution will be merged into the main repository
- Use the present tense ("Add feature" instead of "Added feature")
- Keep the message concise and descriptive
- Use imperative form for the subject (e.g. "Fix typo" instead of "Fixed typo")