Skip to content

Add comprehensive instructions and module index#33

Merged
synthable merged 3 commits intomainfrom
instructions-modules
Jul 14, 2025
Merged

Add comprehensive instructions and module index#33
synthable merged 3 commits intomainfrom
instructions-modules

Conversation

@synthable
Copy link
Copy Markdown
Owner

  • Introduce a new README.md file in the instructions-modules directory, serving as a categorized index of all available instruction modules.

  • Enhance module authoring guide and documentation to link to the new index, improving discoverability and preventing redundancy.

  • Expand README with detailed descriptions for each module to enhance clarity and usability.

Introduces a new README.md file in the instructions-modules directory that serves as a complete, categorized index of all available instruction modules. This provides a single source of truth for browsing and discovering modules.

The module authoring guide and module system documentation have been updated to link to this new index, improving discoverability and helping to prevent the creation of redundant modules.
Added detailed descriptions to each module in the README for clarity and usability.
Copilot AI review requested due to automatic review settings July 14, 2025 21:20
Copy link
Copy Markdown
Contributor

Copilot AI left a 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 PR introduces a suite of new instruction modules across multiple technology and principle domains, centralizing guidance and improving discoverability.

  • Adds detailed Git workflow and commit conventions modules.
  • Expands testing guidance for Vitest, Jest, and Cypress.
  • Introduces OWASP Top 10 security modules and platform-specific best practices (Vercel, Firebase, AWS).
  • Adds persona-builder modules defining module structure, validation rules, and language standards.
  • Completes framework (React), database (PostgreSQL), and numerous principle/methodology modules.

Reviewed Changes

Copilot reviewed 179 out of 179 changed files in this pull request and generated no comments.

Show a summary per file
File Description
instructions-modules/technology/tool/git/interactive-rebase-workflow.md New module for cleaning up commit history with git rebase -i.
instructions-modules/technology/testing/vitest/performance.md Vitest performance optimization guidelines.
instructions-modules/technology/security/owasp-top-10/sql-injection-prevention.md OWASP SQL Injection prevention rules.
instructions-modules/technology/platform/aws/lambda-best-practices.md AWS Lambda best practices module.
instructions-modules/technology/persona-builder/validation-rules.md Persona-builder validation rules module.
instructions-modules/technology/framework/react/rules-of-hooks.md React Rules of Hooks module (incomplete structure).
Comments suppressed due to low confidence (7)

instructions-modules/technology/persona-builder/validation-rules.md:1

  • The frontmatter for this persona-builder module is missing a layer property, which is required for all modules in this section. Please add layer: <integer or null> under the description.
---

instructions-modules/technology/persona-builder/module-structure-standard.md:1

  • This persona-builder module is missing the layer frontmatter field required by the validation rules. Please include layer: <integer or null>.
---

instructions-modules/technology/persona-builder/machine-centric-language.md:1

  • The layer frontmatter is missing from this persona-builder module. Add layer: <integer or null> to satisfy the module validation requirements.
---

instructions-modules/technology/persona-builder/four-tier-philosophy.md:1

  • Add the required layer field to the frontmatter of this persona-builder module. All modules in this category must include layer.
---

instructions-modules/technology/persona-builder/foundation-layer-rules.md:1

  • The frontmatter is missing layer, which is mandatory for persona-builder modules. Please add layer: <integer or null>.
---

instructions-modules/technology/framework/react/rules-of-hooks.md:2

  • The frontmatter is missing a tags field. Please add relevant tags (e.g., react, hooks, best-practices) to this module.
name: 'React Rules of Hooks'

instructions-modules/technology/framework/react/rules-of-hooks.md:6

  • This module does not follow the standard three-section format (## Primary Directive, ## Process, ## Constraints). Please add these sections to conform to the module structure standard.
This is the content for the React Rules of Hooks.

@synthable synthable merged commit 8910142 into main Jul 14, 2025
@synthable synthable deleted the instructions-modules branch July 14, 2025 21:23
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.

2 participants