-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Add MASTG Components Instructions #3447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
… scripts, r2 scripts, techniques, and tools
…, tests, and porting instructions to improve clarity, consistency, and usability across the MASTG framework.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request introduces comprehensive authoring and style guides for various MASTG documentation components. The guides establish standardized conventions for metadata, formatting, cross-linking, and writing across multiple documentation types to ensure consistency and clarity.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
File | Description |
---|---|
porting-mastg-v1-tests-to-v2.instructions.md | Workflow and guidelines for migrating MASTG v1 tests to v2 format |
mastg-tools.instructions.md | Standards for documenting tools used in tests, demos, and techniques |
mastg-test.instructions.md | Comprehensive guide for authoring test documentation with required metadata and sections |
mastg-techniques.instructions.md | Standards for documenting reusable procedures and workflows |
mastg-rules.instructions.md | Guidelines for writing SAST rules, particularly for Semgrep |
mastg-r2-scripts.instructions.md | Conventions for writing and using radare2 scripts in demos |
mastg-mitmproxy-scripts.instructions.md | Standards for mitmproxy Python scripts in MASTG demos |
mastg-knowledge.instructions.md | Guidelines for authoring knowledge articles explaining platform features |
mastg-frida-scripts.instructions.md | Conventions for writing Frida scripts in demos |
mastg-demo.instructions.md | Comprehensive guide for creating demonstrative examples with code samples |
mastg-best-practice.instructions.md | Standards for documenting security best practices |
mastg-apps.instructions.md | Guidelines for documenting reference applications |
markdown.instructions.md | Global markdown formatting and writing style standards |
Comments suppressed due to low confidence (1)
.github/instructions/mastg-demo.instructions.md:1
- "creadit" in the preceding paragraph (line 37) should be "credit".
## Demos
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
.github/instructions/porting-mastg-v1-tests-to-v2.instructions.md
Outdated
Show resolved
Hide resolved
.github/instructions/porting-mastg-v1-tests-to-v2.instructions.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Dionysis Lorentzos <[email protected]>
…d-instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Document prerequisites: Prerequisites are “organizational” things so to say. They are typically context that only the developer companies have such as what’s supposed to be sensitive data (and sensitivity levels), list of first-party packages, list of first-party network domains. An analysis (or automated testing tools) can make some assumptions and guesses but only the developer knows for real.
Co-authored-by: Sven <[email protected]>
Co-authored-by: Sven <[email protected]>
Co-authored-by: Sven <[email protected]>
Co-authored-by: Sven <[email protected]>
Co-authored-by: Dionysis Lorentzos <[email protected]>
Improve grammar and clarity in markdown instructions.
This pull request introduces comprehensive authoring and style guides for various MASTG documentation components. The guides establish standardized conventions for metadata, formatting, cross-linking, and writing across multiple documentation types to ensure consistency and clarity.
These guides will replace: