Skip to content

Set up Copilot coding agent instructions for massweb#68

Merged
P4X-ng merged 2 commits intomasterfrom
copilot/setup-copilot-instructions
Mar 19, 2026
Merged

Set up Copilot coding agent instructions for massweb#68
P4X-ng merged 2 commits intomasterfrom
copilot/setup-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 19, 2026

.github/copilot-instructions.md existed 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.md

  • Project overview — what MassWeb is, who built it, and what scale it operates at
  • Repository structure — annotated directory tree covering all modules (mass_requests/, fuzzers/, vuln_checks/, targets/, etc.)
  • Build & test commandspip install -e ., python -m unittest discover test/, make test
  • Architecture patterns — Target→FuzzyTarget pipeline, multiprocessing (not threads) model, __PNK_THREAD_TIMEOUT/__PNK_FAILED_RESPONSE sentinel strings, Check base class contract
  • Coding conventions — Python 3.7–3.12 range, how to add new vuln checks, no demo code in production paths, code length limits, TODO.md instead of inline TODOs
  • Tooling preferences — Podman over Docker, Python/C/Rust/TypeScript selection criteria, Playwright for web testing, TLS requirement, key-value store over Postgres
  • Style rules — no emojis, no color output, production-only code

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:

  • gh.io
    • Triggering command: /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

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 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.md from 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.md policy, repo organization, Podman preference).

Written by Cursor Bugbot for commit ec48587. Configure here.

Co-authored-by: P4X-ng <223870169+P4X-ng@users.noreply.github.com>
Copilot AI changed the title [WIP] Add setup instructions for Copilot Set up Copilot coding agent instructions for massweb Mar 19, 2026
Copilot AI requested a review from P4X-ng March 19, 2026 06:09
@P4X-ng P4X-ng marked this pull request as ready for review March 19, 2026 23:13
@P4X-ng P4X-ng merged commit 339689b into master Mar 19, 2026
10 of 24 checks passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants