Contributing to Fawkes
Thank you for your interest in contributing to Fawkes! This guide will help you get started with contributing to the project.
Development Workflow
1. Trunk-Based Development
We follow trunk-based development practices:
# Clone the repository
git clone https://github.com/paruff/fawkes.git
cd fawkes
# Create a feature branch
git checkout -b feature/your-feature-name
# Make your changes
# Commit frequently with clear messages
git add .
git commit -m "feat: description of your change"
# Push your changes
git push origin feature/your-feature-name
2. Development Guidelines
| Guideline | Description |
|---|---|
 Branch Lifetime |
Merge within 24 hours |
 Testing |
Include tests with all changes |
 Documentation |
Update relevant docs |
 CI/CD |
Ensure all checks pass |
Adding New Content
Documentation
---
title: Your Page Title
description: Brief description of the page content
---
# Your Page Title
Content goes here following the standard format:
- Use H2 (##) for main sections
- Use tables for structured information
- Include related links
Implementation Patterns
When adding new patterns:
- Create pattern file in
docs/patterns/ - Add to navigation in
mkdocs.yml - Link from relevant capabilities
- Include example implementations
Tool Integration
When adding new tools:
- Create tool doc in
docs/tools/ - Add to navigation in
mkdocs.yml - Link from relevant patterns
- Include configuration examples
Testing Changes
# Install dependencies
pip install -r requirements.txt
# Run local development server
mkdocs serve
# Build documentation
mkdocs build
Submitting Changes
- Create Issue
- Describe the problem or enhancement
-
Reference related DORA capabilities
-
Submit Pull Request
- Reference the issue
- Include clear description
- Update documentation
-
Add tests if applicable
-
Review Process
- Peer review required
- All checks must pass
- Documentation updated
Getting Help
- Create an issue on GitHub
- Join our community discussions
- Review existing documentation