# Contribution Guidelines Thank you for considering contributing to Gonzo! It's people like you that make Gonzo such a great tool. This guide covers how to contribute effectively. ### Code of Conduct This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code: * **Be respectful**: Treat everyone with respect and courtesy * **Be inclusive**: Welcome and support people of all backgrounds * **Be collaborative**: Work together to improve the project * **Be professional**: Keep discussions on topic and constructive ### How Can I Contribute? #### Reporting Bugs Before creating bug reports, please check [existing issues](https://github.com/control-theory/gonzo/issues) as you might find out that you don't need to create one. **When creating a bug report, include**: * **Clear title**: Describe the issue concisely * **Reproduction steps**: Exact steps to reproduce the problem * **Expected behavior**: What you expected to happen * **Actual behavior**: What actually happened * **Environment details**: * Operating System (macOS, Linux, Windows) * Go version (`go version`) * Gonzo version (`gonzo --version`) * Terminal emulator * **Logs and screenshots**: Include relevant output * **Sample logs**: Sanitized log files if relevant **Bug Report Template**: ```markdown **Describe the bug** A clear description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. Run command '...' 2. Press key '...' 3. See error **Expected behavior** What you expected to happen. **Screenshots/Logs** If applicable, add screenshots or log output. **Environment:** - OS: [e.g., macOS 14.0] - Go Version: [e.g., 1.21.5] - Gonzo Version: [e.g., v0.1.6] - Terminal: [e.g., iTerm2] **Additional context** Any other context about the problem. ``` #### Suggesting Enhancements Enhancement suggestions are tracked as [GitHub issues](https://github.com/control-theory/gonzo/issues). **When creating an enhancement suggestion, include**: * **Clear title**: Describe the enhancement concisely * **Detailed description**: Explain what you want to add * **Use cases**: Why would this be useful? * **Current behavior**: What happens now? * **Proposed behavior**: What should happen? * **Examples**: Show how it would work * **Alternatives**: Have you considered other solutions? **Enhancement Template**: ```markdown **Is your feature request related to a problem?** A clear description of the problem. Ex. I'm frustrated when [...] **Describe the solution you'd like** A clear description of what you want to happen. **Describe alternatives you've considered** Other solutions or features you've considered. **Additional context** Any other context, mockups, or examples. ``` #### Pull Requests **Before submitting a pull request**: 1. **Fork the repository** 2. **Create your branch** from `main` ```bash git checkout -b feature/amazing-feature ``` 3. **Make your changes** 4. **Add tests** if you've added code 5. **Update documentation** if you've changed APIs 6. **Ensure tests pass** ```bash make test ``` 7. **Format and lint your code** ```bash make fmt make vet ``` 8. **Commit your changes** 9. **Push to your fork** 10. **Open a Pull Request** **Pull Request Checklist**: * [ ] Code follows the project's style guide * [ ] Self-review of code completed * [ ] Comments added for complex code * [ ] Documentation updated * [ ] No new warnings introduced * [ ] Tests added for new features * [ ] All tests passing * [ ] Commits follow commit message guidelines ### Development Guidelines #### Commit Messages Follow these guidelines for commit messages: **Format**: ``` :