|
| 1 | +# Contributing to AWS MCP Proxy |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the AWS MCP Proxy Server! We welcome contributions from the community. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +1. **Fork the repository** on GitHub |
| 8 | +2. **Set up your development environment** - see [DEVELOPMENT.md](DEVELOPMENT.md) for detailed setup instructions |
| 9 | +3. **Create a feature branch** from `main` |
| 10 | +4. **Make your changes** following our coding standards |
| 11 | +5. **Run tests and quality checks** to ensure everything works |
| 12 | +6. **Submit a pull request** with a clear description |
| 13 | + |
| 14 | +For detailed technical information, development workflow, and troubleshooting, see [DEVELOPMENT.md](DEVELOPMENT.md). |
| 15 | + |
| 16 | +## Ways to Contribute |
| 17 | + |
| 18 | +### 🐛 Reporting Bugs |
| 19 | +- Use GitHub Issues to report bugs |
| 20 | +- Include steps to reproduce, expected vs actual behavior |
| 21 | +- Provide AWS region, Python version, and relevant logs |
| 22 | +- Check existing issues to avoid duplicates |
| 23 | + |
| 24 | +### 💡 Suggesting Features |
| 25 | +- Open a GitHub Issue with the "enhancement" label |
| 26 | +- Describe the use case and expected behavior |
| 27 | +- Consider MCP specification compatibility |
| 28 | +- Discuss design before implementing large changes |
| 29 | + |
| 30 | +### 🔧 Code Contributions |
| 31 | +- Follow the development workflow in [DEVELOPMENT.md](DEVELOPMENT.md) |
| 32 | +- Ensure tests pass: `uv run pytest --cov` |
| 33 | +- Follow code quality standards: `uv run pre-commit run --all-files` |
| 34 | +- Use conventional commit messages (enforced by pre-commit hooks) |
| 35 | + |
| 36 | +### 📚 Documentation |
| 37 | +- Improve README.md, DEVELOPMENT.md, or code documentation |
| 38 | +- Add examples or clarify existing instructions |
| 39 | +- Fix typos or broken links |
| 40 | + |
| 41 | +## Code of Conduct |
| 42 | + |
| 43 | +- **Be respectful and inclusive** in all interactions |
| 44 | +- **Focus on constructive feedback** during code reviews |
| 45 | +- **Help others learn** - explain reasoning behind suggestions |
| 46 | +- **Follow professional standards** appropriate for AWS projects |
| 47 | + |
| 48 | +## Pull Request Guidelines |
| 49 | + |
| 50 | +### Before Submitting |
| 51 | +- [ ] Read [DEVELOPMENT.md](DEVELOPMENT.md) and set up your environment |
| 52 | +- [ ] Create tests for new functionality |
| 53 | +- [ ] Ensure all tests pass locally |
| 54 | +- [ ] Run code quality tools (`ruff`, `pyright`, `pre-commit`) |
| 55 | +- [ ] Update documentation if needed |
| 56 | + |
| 57 | +### PR Description Should Include |
| 58 | +- **What**: Brief description of changes |
| 59 | +- **Why**: Reason for the change (issue reference, use case) |
| 60 | +- **How**: Technical approach if complex |
| 61 | +- **Testing**: How you verified the changes work |
| 62 | + |
| 63 | +### Example PR Title |
| 64 | +``` |
| 65 | +feat(auth): add support for custom SigV4 signing profiles |
| 66 | +``` |
| 67 | + |
| 68 | +## Development Standards |
| 69 | + |
| 70 | +- **Python**: 3.10+ with type hints |
| 71 | +- **Code Style**: Follow `ruff` configuration (99 char line limit) |
| 72 | +- **Testing**: Maintain 80%+ test coverage |
| 73 | +- **Commits**: Use [Conventional Commits](https://www.conventionalcommits.org/) format |
| 74 | +- **Documentation**: Update relevant docs with changes |
| 75 | + |
| 76 | +## Getting Help |
| 77 | + |
| 78 | +- **Technical Issues**: See troubleshooting in [DEVELOPMENT.md](DEVELOPMENT.md) |
| 79 | +- **Questions**: Open a GitHub Discussion or Issue |
| 80 | +- **MCP Specification**: Refer to [Model Context Protocol](https://spec.modelcontextprotocol.io/) |
| 81 | + |
| 82 | +## License |
| 83 | + |
| 84 | +By contributing, you agree that your contributions will be licensed under the Apache 2.0 License that covers this project. |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +**New to the project?** Start with [DEVELOPMENT.md](DEVELOPMENT.md) for complete setup and development instructions. |
0 commit comments