Skip to content

Jason/instructions update#228

Merged
jasonmorais merged 2 commits intomainfrom
jason/instructions-update
Oct 23, 2025
Merged

Jason/instructions update#228
jasonmorais merged 2 commits intomainfrom
jason/instructions-update

Conversation

@jasonmorais
Copy link
Contributor

@jasonmorais jasonmorais commented Oct 21, 2025

Summary by Sourcery

Standardize and reorganize Copilot instruction markdown across GraphQL, UI components, layouts, pages, and backend API docs to improve clarity, consistency, and maintainability.

Enhancements:

  • Streamline GraphQL frontend instructions with concise sections for organization, naming, coding guidelines, Apollo link chain setup, integration, and testing.
  • Revise layout guidelines to clarify file conventions, routing structure, patterns, styling, state management, accessibility, testing, and folder organization.
  • Condense backend API GraphQL docs to a succinct summary of architecture, core components, coding standards, context setup, and testing/security/performance considerations.
  • Refactor UI, components, pages, container, and presentational instruction files to unify structure, naming conventions, co-location practices, styling, accessibility, and testing requirements.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 21, 2025

Reviewer's Guide

This PR refactors and streamlines the Copilot instruction documents across multiple instruction files. It removes outdated headers, unifies section headings and bullet conventions, consolidates repetitive guidance, and reorganizes content into concise, focused overviews for each area (GraphQL, layouts, components, pages, containers, and presentational elements).

Class diagram for updated UI component structure

classDiagram
  class MoleculeComponent {
    +props: MoleculeComponentProps
    +index.tsx
    +index.test.tsx
    +index.stories.tsx
    +index.module.css
    +README.md
  }
  class OrganismComponent {
    +props: OrganismComponentProps
    +index.tsx
    +index.test.tsx
    +index.stories.tsx
    +index.module.css
    +README.md
  }
  MoleculeComponent <|-- OrganismComponent: composed of

  class ContainerComponent {
    +props: ContainerComponentProps
    +dataFetching
    +businessLogic
    +wraps PresentationalComponent
  }
  class PresentationalComponent {
    +props: PresentationalComponentProps
    +UI rendering
    +localState
  }
  ContainerComponent --> PresentationalComponent: wraps

  class GraphQLFile {
    +queries
    +mutations
    +fragments
  }
  ContainerComponent --> GraphQLFile: imports

  class PageComponent {
    +props: PageComponentProps
    +routeMapping
    +composes UI from containers/components
  }
  PageComponent --> ContainerComponent: composes
  PageComponent --> PresentationalComponent: composes

  class LayoutComponent {
    +props: LayoutComponentProps
    +routing
    +navigation
    +sharedUI
  }
  LayoutComponent --> PageComponent: wraps
  LayoutComponent --> ContainerComponent: may wrap
  LayoutComponent --> PresentationalComponent: may wrap
Loading

File-Level Changes

Change Details Files
Streamlined GraphQL UI instructions
  • Removed obsolete applyTo header
  • Combined Purpose and Organization under concise headings
  • Reordered sections for clarity and brevity
.github/instructions/ui/graphql.instructions.md
Refactored layout instructions
  • Removed applyTo directive
  • Simplified Architecture & Patterns into Patterns & Structure
  • Condensed file conventions and routing guidance
.github/instructions/ui/layouts.instructions.md
Condensed API GraphQL instructions
  • Renamed Purpose to Summary
  • Updated Architecture section with bulletized patterns
  • Merged Core Components into a unified Components list
packages/sthrift/graphql/.github/instructions/api-graphql.instructions.md
Unified UI component guidelines
  • Merged Architecture & Patterns into a Principles overview
  • Focused on typing, styling, and testing conventions
  • Trimmed redundant examples and lists
.github/instructions/ui/components.instructions.md
Simplified Atomic Design (ui) instructions
  • Consolidated molecule/organism definitions
  • Standardized file/folder structure examples
  • Removed verbose notes and normalized formatting
.github/instructions/ui/ui.instructions.md
Reorganized page component docs
  • Moved Page Types under clear headings
  • Unified Single Page and Page Group patterns
  • Streamlined conventions and testing guidance
.github/instructions/ui/pages.instructions.md
Updated container component guidance
  • Replaced Purpose/Architecture with Overview/Principles
  • Emphasized Apollo and ComponentQueryLoader usage
  • Condensed file organization rules
.github/instructions/ui/container-components.instructions.md
Normalized presentational component docs
  • Clarified stateless role and local UI state scope
  • Unified coding conventions under Conventions
  • Simplified styling and testing sections
.github/instructions/ui/presentational-components.instructions.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jasonmorais jasonmorais merged commit fa0c939 into main Oct 23, 2025
8 checks passed
@jasonmorais jasonmorais deleted the jason/instructions-update branch October 23, 2025 15:23
arif-u-ahmed pushed a commit that referenced this pull request Nov 4, 2025
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.

1 participant