Add comprehensive GitHub Copilot instructions for OWASP MAS website development #19
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed guidance for working effectively in the OWASP MAS website repository.What's Included
The instructions cover all essential aspects of working with this MkDocs-based website:
🚀 Complete Setup Process
pip install -r requirements.txt⏱️ Validated Timing & Performance
All commands have been thoroughly tested with accurate timing expectations:
🛡️ Critical Safety Measures
🔧 Development Workflow
./run_web.sh)✅ Comprehensive Validation
All instructions have been validated through end-to-end testing:
Why This Matters
This repository involves complex build processes that aggregate content from multiple external repositories (MASTG, MASVS, MASWE) using custom MkDocs hooks. Without proper guidance, developers often encounter:
These instructions eliminate these common pitfalls and enable developers to be productive immediately.
Fixes #18.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/OWASP/mastg/actions/workflows/build-android-demos.yml/runs/usr/bin/python3 /home/REDACTED/.local/bin/mkdocs serve -a localhost:8000 --no-livereload(http block)https://api.github.com/repos/OWASP/mastg/actions/workflows/build-ios-demos.yml/runs/usr/bin/python3 /home/REDACTED/.local/bin/mkdocs serve -a localhost:8000 --no-livereload(http block)https://api.github.com/repos/OWASP/masvs/releases/latestcurl -s REDACTED(http block)https://api.github.com/search/issues/usr/bin/python3 /home/REDACTED/.local/bin/mkdocs build --verbose(http block)/usr/bin/python3 /home/REDACTED/.local/bin/mkdocs build --clean --verbose(http block)/usr/bin/python3 /home/REDACTED/.local/bin/mkdocs serve -a localhost:8000(http block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.