Submitting Changes
How to contribute code to the project.
Workflow
- Fork the repository on GitHub
- Create a branch:
feat/my-featureorfix/my-fix - Make changes: Follow the code style guide
- Run tests locally:
cd mcp-servers/shared/mcp-permission-engine && python -m pytest tests/ -vcd mcp-webui && npm run typecheck && npm test
- Commit with a descriptive message
- Push to your fork
- Open a pull request against
main
PR Guidelines
- One concern per PR: Don't mix feature changes with refactoring
- Description: Explain what, why, and any trade-offs
- Tests: Add tests for new functionality
- Screenshots: Include for UI changes
- Breaking changes: Call them out explicitly
PR Template
Fill in the PR description with:
- What does this change do?
- Why is it needed?
- How was it tested?
- Any breaking changes?
- Screenshots (if UI changes)
Review Process
- CI must pass (lint, test, build)
- At least one maintainer review required
- Address review feedback
- Squash merge into
main
Issue Templates
Use the appropriate template when opening issues:
- Bug Report: Steps to reproduce, expected vs actual behavior, logs
- Feature Request: Use case, proposed solution, alternatives considered
- Documentation: What's missing or incorrect
- Security: Use the security template (private disclosure)