Documentation
¶
Overview ¶
Package programguide holds the model-facing descriptions of programs codeaf carries. The prefix budget reads them on every build platform, even where a program's runnable engine is absent.
Index ¶
Constants ¶
const Review = "For a code review of a GitHub pull request; it changes no files and posts nothing. Its brief is " +
"the pull request (link, `owner/repo#N` or `#N`), or nothing for this branch's, then any focus."
Review is the guide review gives the conversation. Its brief is read by the program itself (internal/praf's ReadBrief), so the guide spells it as the program reads it.
const Sec = "For a security audit of code: the whole repository, or only the changes on this branch. " +
"It hunts for vulnerabilities, traces each from input to sink, sets aside what it cannot show exploitable, " +
"and reports the rest with file, line and fix; it changes no files. Its brief is `whole repository` or " +
"`changes` (`changes since <ref>` for another base), optionally with `quick` or `thorough`."
Sec is the guide sec gives the conversation. Its brief is read by the program itself (internal/secaf's scope reading), so the guide spells the brief's few words exactly as the program reads them.
const SeniorDev = "For complex, multi-part coding work: fixing an issue in a mature codebase whose cause " +
"spans files, a feature with tests, a rewrite of a package, a migration. Its brief " +
"carries the issue or ask in full, what done means and how to check it, and what must not change."
SeniorDev is the guide senior-dev gives the conversation. The Unix program and the platform-independent prefix measurement share these exact bytes.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files