Contributing to goflow#

Getting Started#

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/goflow.git
  3. Create a new branch: git checkout -b feature/your-feature-name

Development Setup#

# Install dependencies
go mod download

# Install development tools and pre-commit hook
make install-tools
make install-hooks

# Run tests
make test

# Run linter
make lint

# Run benchmarks
make benchmark

Code Guidelines#

  • Follow Go idioms and conventions
  • Write clear, concise comments
  • Add tests for new functionality
  • Update documentation as needed
  • Ensure all tests pass before submitting

Pull Request Process#

  1. Ensure your code follows the project’s coding standards
  2. Add tests for any new functionality
  3. Update documentation if needed
  4. Submit a pull request with a clear description
  5. Address any feedback from maintainers

Testing#

  • Write unit tests for all new code
  • Ensure test coverage remains high
  • Run the full test suite before submitting

License#

By contributing, you agree that your contributions will be licensed under the MIT License.

Backward Reference Security Forward