trailofbits / trailofbits/testing-handbook

codeql manifest

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
135
Forks
22
PR merge metrics
No merged PRs in 30d

Description

We should mention that the codeqlmanifest.json is necessary to inform CLI about custom rules - https://github.com/github/codeql-coding-standards/blob/main/.codeqlmanifest.json

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked .codeqlmanifest.json and locate the handbook passage where custom CodeQL rules or the CLI are discussed. Update the relevant documentation to explain that the manifest is necessary for the CLI to recognize custom rules, then verify the wording and link render correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.