Thank you for your interest in contributing to Gonfig! This document outlines some guidelines and information to help make the contribution process smooth and effective for everyone involved.
We welcome contributions of all kinds, including but not limited to:
- Bug fixes
- New features
- Documentation improvements
- Code cleanup and refactoring
- Tests and test coverage improvements
Contributing to Gonfig is a straightforward process:
- Fork the repository and clone it to your machine.
- Make the desired changes to the codebase.
- Write tests for your changes.
- Ensure that all tests pass and the codebase is linted and formatted correctly.
- Commit your changes and push them to your forked repository.
- Open a pull request with a clear description of the changes you made and why they are necessary.
Before submitting a pull request, please consider the following guidelines:
- Follow good coding practices, including clear and concise variable and function names, appropriate struct and interface design, and consistent formatting and styling.
- Include tests for any new functionality or bug fixes.
- If you are adding a new feature, please include documentation for it in the README.md file.
- Be responsive to feedback and willing to make changes based on code reviews.
Gonfig is committed to providing a friendly, safe, and welcoming environment for all contributors. Please read our code of conduct for more information.
By contributing to Gonfig, you agree that your contributions will be licensed under the MIT License.
Thank you for your contributions and for helping to make Gonfig a better tool for everyone!