Contributing to binbash Leverage

Thank you for your interest in contributing to binbash Leverage! This guide covers how to contribute to documentation and other parts of the Leverage ecosystem. You're in the right place - continue reading below to find the right project for your interests.

How You Can Contribute

📝 Documentation Contributions

• Fix errors: Correct technical inaccuracies and outdated information
• Improve clarity: Make explanations easier to understand
• Add examples: Include practical code examples and use cases
• Fill gaps: Add missing documentation or troubleshooting sections
• Fix broken links: Ensure all references are working
• Improve formatting: Enhance readability and visual presentation

🏗️ Infrastructure & Code Contributions

• Reference Architecture: Improve AWS infrastructure layers and multi-account setup
• Terraform Modules: Enhance existing modules or create new ones for AWS services
• Leverage CLI: Add new features, improve user experience, and optimize performance
• Bug Fixes: Help identify and resolve issues across all projects
• Testing: Add or improve automated testing and validation

🚀 Quick Start

For Documentation Contributions

1. Fork this repository on GitHub: le-ref-architecture-doc
2. Clone and setup:

   git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git
   cd le-ref-architecture-doc
   make init-makefiles  # Required: downloads external makefiles
   make docs-live       # Start dev server at http://localhost:8000
   

For Other Project Contributions

Choose the repository that matches your interests:

• Reference Architecture: AWS infrastructure code
• CLI Tool: Command-line interface
• Terraform Modules: 50+ AWS modules

Each repository has setup instructions in its README file.

📝 Contributing Process

General Workflow

1. Choose your project: Pick from documentation, infrastructure, CLI, or modules
2. Fork and clone: Fork the relevant repository and clone your fork
3. Create a branch: Use descriptive names like feat/new-feature or docs/improve-guide
4. Make changes: Follow the project's specific guidelines
5. Test locally: Verify your changes work as expected
6. Submit PR: Create a clear pull request with description

Project-Specific Guidelines

• Documentation: Use clear language, test examples, check links
• Infrastructure: Follow AWS Well-Architected principles, include examples
• CLI: Include tests, follow Python best practices, update documentation
• Modules: Maintain consistency, add comprehensive documentation

📞 Getting Help

Need assistance? Here's how to get help:

1. Check existing documentation and GitHub issues
2. Report issues in this repository
3. Email support: leverage@binbash.co

---

Thank you for contributing to binbash Leverage! Your contributions help make cloud infrastructure more accessible and reliable for everyone! 🚀