Skip to content

Conversation

@agatha197
Copy link
Contributor

@agatha197 agatha197 commented Nov 18, 2025

resolves FR-1634

Enhance React Compiler Documentation and Best Practices

This PR significantly expands the React Compiler documentation, particularly around the use memo directive. It clarifies that:

  • The project uses React Compiler with directives like use memo and use client
  • These directives are intentional and valid even if tooling shows warnings
  • Developers should not remove or "fix" these directives

The PR adds detailed guidance on:

  • When and how to use React directives
  • Proper code style for React files
  • How to handle React directives in components

Additionally, the documentation formatting has been improved throughout with better spacing and organization of bullet points.

Checklist:

  • Documentation

AI: I've created a pull request description that focuses specifically on the changes made to the React Compiler documentation. The description highlights the key additions regarding the use memo directive, explains the purpose of these changes (to prevent confusion and incorrect "fixes"), and maintains a professional, concise format that matches the requested template.

Copy link
Contributor Author

agatha197 commented Nov 18, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • flow:merge-queue - adds this PR to the back of the merge queue
  • flow:hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has required the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@agatha197 agatha197 changed the base branch from feat_FR-1679_/add-auto-refresh-to-container-logs to graphite-base/4667 November 18, 2025 13:37
@agatha197 agatha197 changed the base branch from graphite-base/4667 to main November 18, 2025 13:37
Copilot finished reviewing on behalf of agatha197 November 19, 2025 04:04
Copy link
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 enhances the React Compiler documentation in the GitHub instructions, focusing on clarifying the intentional use of the use memo directive and preventing developers from removing it due to tooling warnings.

Key Changes:

  • Added comprehensive guidance on React Compiler directives (use memo, use client) with explicit warnings not to remove them despite IDE warnings
  • Reorganized documentation with improved spacing and structure throughout all sections
  • Added a new "Code style for React files" section explaining proper directive placement

Copy link
Member

@yomybaby yomybaby left a comment

Choose a reason for hiding this comment

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

LGTM

@graphite-app
Copy link

graphite-app bot commented Nov 19, 2025

Merge activity

…#4667)

resolves FR-1634

# Enhance React Compiler Documentation and Best Practices

This PR significantly expands the React Compiler documentation, particularly around the `use memo` directive. It clarifies that:

- The project uses React Compiler with directives like `use memo` and `use client`
- These directives are intentional and valid even if tooling shows warnings
- Developers should not remove or "fix" these directives

The PR adds detailed guidance on:

- When and how to use React directives
- Proper code style for React files
- How to handle React directives in components

Additionally, the documentation formatting has been improved throughout with better spacing and organization of bullet points.

**Checklist:**

- [x] Documentation

AI: I've created a pull request description that focuses specifically on the changes made to the React Compiler documentation. The description highlights the key additions regarding the `use memo` directive, explains the purpose of these changes (to prevent confusion and incorrect "fixes"), and maintains a professional, concise format that matches the requested template.
@graphite-app graphite-app bot merged commit 1b46ac6 into main Nov 19, 2025
8 checks passed
@graphite-app graphite-app bot deleted the fix/FR-1634 branch November 19, 2025 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30~100 LoC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants