Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (51 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 2.08 KB

Contributing

Thank you for your interest in improving this workshop!

Quick Links

Repository Structure

sherpa/
├── camps/                    # Workshop modules
│   ├── base-camp/            # Local-only, MCP fundamentals
│   ├── camp1-identity/       # Azure: OAuth, Managed Identity
│   ├── camp2-gateway/        # Azure: APIM, Content Safety
│   ├── camp3-io-security/    # Azure: Input validation, PII
│   └── camp4-monitoring/     # Azure: Logging, alerts
├── docs/                     # MkDocs documentation
│   └── camps/                # Workshop guides
└── mkdocs.yml

Workshop Pattern

All camps follow exploit → fix → validate:

  1. Start with a vulnerable or incomplete configuration
  2. Demonstrate the security risk
  3. Apply the fix
  4. Validate the fix works

Camp Types

Type Example Deployment Key Files
Local Base Camp uv run python -m src.server vulnerable-server/, secure-server/
Azure Camps 1-4 azd up azure.yaml, infra/, scripts/

Running Docs Locally

pip install -r requirements-docs.txt
mkdocs serve

Code Guidelines

  • Python: 3.11+, type hints, uv for dependencies
  • Bicep: Consistent naming, security comments
  • Scripts: Bash, set -e, clear progress output

Testing Changes

  1. Run through the workshop guide yourself
  2. Verify exploit scripts demonstrate the vulnerability
  3. Verify fix scripts resolve the issue
  4. Check documentation renders correctly

Submitting Changes

  1. Fork and create a branch
  2. Make changes and test thoroughly
  3. Submit a Pull Request with a clear description

Questions?

Open an issue.

Thank you for helping others reach the summit safely! 🏔️