Improved the existing instruction files#3671
Merged
cpholguera merged 11 commits intomasterfrom Jan 29, 2026
Merged
Conversation
- Introduced a new index.md file with guidelines for writing various MASTG content types, including tests, demos, knowledge articles, techniques, tools, and best practices. - Updated markdown.instructions.md to correct the weakness identifier example and improve the description. - Enhanced all mastg-xxxx.instructions.md with metadata to be used as instructions for certain areas.
…d-instructions-index
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the MASTG instruction files by introducing YAML front matter metadata, improving documentation structure, and adding a comprehensive index file to help contributors navigate the various content authoring guidelines.
Changes:
- Added YAML front matter with
descriptionandapplyTofields to all instruction files for better organization and automation - Created a new index.md file that serves as a comprehensive guide to all available instruction documents
- Updated markdown.instructions.md to correct the weakness identifier example (MASWE-0023 instead of MASWE-0123)
- Improved heading hierarchy across multiple instruction files by demoting top-level headings from H2 to H3 where appropriate
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| porting-mastg-v1-tests-to-v2.instructions.md | Added YAML front matter and adjusted heading levels (H2→H3) |
| mastg-tools.instructions.md | Added YAML front matter, restructured content with improved guidance on tool documentation |
| mastg-test.instructions.md | Added YAML front matter and adjusted heading hierarchy for metadata sections |
| mastg-techniques.instructions.md | Added YAML front matter, improved content organization with more flexible structure guidance |
| mastg-rules.instructions.md | Added YAML front matter and enhanced Semgrep documentation with better descriptions |
| mastg-r2-scripts.instructions.md | Added YAML front matter and improved radare2 script authoring guidelines |
| mastg-mitmproxy-scripts.instructions.md | Added YAML front matter and H1 title heading for consistency |
| mastg-knowledge.instructions.md | Added YAML front matter and H1 title heading |
| mastg-frida-scripts.instructions.md | Added YAML front matter for Frida script guidelines |
| mastg-demo.instructions.md | Added YAML front matter and adjusted heading hierarchy |
| mastg-best-practice.instructions.md | Added YAML front matter for best practices documentation |
| mastg-apps.instructions.md | Added YAML front matter for app reference pages |
| markdown.instructions.md | Corrected weakness identifier example and updated description capitalization |
| index.md | New comprehensive index file listing all instruction guidelines with navigation and quality standards |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 32 out of 32 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cpholguera
commented
Jan 29, 2026
sk3l10x1ng
pushed a commit
to sk3l10x1ng/owasp-mastg
that referenced
this pull request
Jan 30, 2026
* Improved the existing instruction files: - Introduced a new index.md file with guidelines for writing various MASTG content types, including tests, demos, knowledge articles, techniques, tools, and best practices. - Updated markdown.instructions.md to correct the weakness identifier example and improve the description. - Enhanced all mastg-xxxx.instructions.md with metadata to be used as instructions for certain areas. * Add metadata header to Frooky hook configurations guide * fix md lint * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update tool metadata to use 'hosts' key for operating systems * Update instruction files to replace 'description' with 'name' for consistency * Add anything missing from the style guide * Apply suggestions from code review * fix urls * Update instruction files to replace 'name' with 'title' for consistency --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mastg-xxxx.instructions.mdwith metadata to be used as instructions for certain areas..github/instructions/markdown.instructions.mdcovers what we had in the style guide.