Skip to content

Commit Message Guidelines

Follow conventional commit format for clear commit history:

type(scope): description

feat(uniswap): add support for new pool types
fix(pricing): resolve decimal precision issues
docs(readme): update configuration instructions
chore(deps): update dependencies

Types:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • chore: Maintenance tasks
  • refactor: Code refactoring
  • test: Test additions/changes

Documentation

When contributing:

  • Code comments: Document complex logic and algorithms
  • README updates: Update documentation for new features
  • Configuration examples: Provide clear configuration examples
  • API documentation: Document any API changes

Code Review Process

All contributions go through code review:

  1. Automated checks: CI runs linting, formatting, and tests
  2. Manual review: Team members review code for quality and correctness
  3. Feedback incorporation: Address review comments
  4. Approval and merge: Changes are merged after approval