Set up Copilot coding agent instructions for massweb#68
Conversation
Co-authored-by: P4X-ng <223870169+P4X-ng@users.noreply.github.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ec485875ae
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - Python 3.7+ compatibility required; supports up to 3.12. | ||
| - New vulnerability checks: create a file in `massweb/vuln_checks/`, inherit from `Check`, implement `check(content)`, and register in `WebFuzzer._run_checks()`. | ||
| - No demo code mixed with production code. Demo code goes in `demo/` and must show a large `DEMO` banner. | ||
| - All documentation goes in `docs/`. Do not scatter doc files in the root. |
There was a problem hiding this comment.
Exempt required root docs from docs-only rule
This instruction states that all documentation should live in docs/, but the package metadata still requires a root-level readme (pyproject.toml sets readme = "README.txt"). If Copilot follows this guidance during cleanup and moves root docs into docs/, build/publish flows can fail when metadata generation cannot find the referenced readme file.
Useful? React with 👍 / 👎.
.github/copilot-instructions.mdexisted but contained only generic agent preferences with no project-specific context, making Copilot largely uninformed about how to work in this repo.Changes to
.github/copilot-instructions.mdmass_requests/,fuzzers/,vuln_checks/,targets/, etc.)pip install -e .,python -m unittest discover test/,make test__PNK_THREAD_TIMEOUT/__PNK_FAILED_RESPONSEsentinel strings,Checkbase class contractTODO.mdinstead of inline TODOsWarning
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:
gh.io/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.
Note
Low Risk
Documentation-only change that updates
.github/copilot-instructions.md; no runtime code, tests, or dependencies are modified.Overview
Expands
.github/copilot-instructions.mdfrom generic agent preferences into a MassWeb-specific guide, adding project/repo overview, build/test commands, key architectural patterns, and explicit workflow/tooling/style rules (e.g.,TODO.mdpolicy, repo organization, Podman preference).Written by Cursor Bugbot for commit ec48587. Configure here.