Thank you for your interest in contributing to Gödel! This document provides guidelines and instructions for contributing to this project.
Please be respectful and considerate of others when contributing to this project.
Before submitting a bug report:
- Check the issue tracker to see if the issue has already been reported.
- Try to reproduce the issue with the latest version.
When submitting a bug report, please include:
- A clear and descriptive title.
- Detailed steps to reproduce the issue.
- Expected behavior and what actually happens.
- Any relevant logs, screenshots, or code samples.
Feature suggestions are welcome. Please provide:
- A clear and descriptive title.
- A detailed description of the proposed feature.
- Any relevant context or examples.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with clear, descriptive messages.
- Push your branch to your fork.
- Submit a pull request to the main repository.
- Follow the existing code style.
- Add tests for new features and ensure all tests pass.
- Update documentation if necessary.
- Keep pull requests focused on a single issue or feature.
- Clone your fork of the repository.
- Set up the required dependencies:
go mod download - Build the project:
./build.sh
Run tests using:
go test ./...
- Follow Go's standard formatting guidelines (use
go fmt). - Write clear, self-explanatory code and add comments where necessary.
- Keep functions and methods small and focused on a single task.
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.