Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (54 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

76 lines (54 loc) · 1.73 KB

Contributing to AegisFlow

Thank you for your interest in contributing to AegisFlow. This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/aegisflow.git
  3. Create a branch: git checkout -b feature/your-feature
  4. Make your changes
  5. Run tests: make test
  6. Run linting: make lint
  7. Commit and push
  8. Open a Pull Request

Development Setup

# Install Go 1.24+
brew install go

# Build
make build

# Run locally
make run

# Run tests
make test

# Run with Docker
make docker-up

Areas to Contribute

Add a New Provider

  1. Create internal/provider/yourprovider.go
  2. Implement the Provider interface (6 methods)
  3. Add tests in internal/provider/yourprovider_test.go
  4. Register the type in cmd/aegisflow/main.go initProviders()
  5. Add config support in internal/config/config.go

Add a New Policy Filter

  1. Create internal/policy/filter_yourfilter.go
  2. Implement the Filter interface (3 methods)
  3. Add tests
  4. Register in cmd/aegisflow/main.go initPolicyEngine()

Other Contributions

  • Bug fixes
  • Documentation improvements
  • Performance optimizations
  • Test coverage improvements

Code Standards

  • Follow standard Go conventions
  • All exported functions must have tests
  • Run gofmt -s -w . before committing
  • Run golangci-lint run ./... and fix all issues
  • Keep packages small and focused

Pull Request Process

  1. Ensure all tests pass
  2. Update documentation if needed
  3. Keep PRs focused — one feature or fix per PR
  4. Write a clear description of what changed and why

License

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