Skip to content

Add Next.js Best Practices for LLMs (2025)#120

Merged
codemillmatt merged 1 commit into
github:mainfrom
burkeholland:burkeholland-nextjs
Jul 24, 2025
Merged

Add Next.js Best Practices for LLMs (2025)#120
codemillmatt merged 1 commit into
github:mainfrom
burkeholland:burkeholland-nextjs

Conversation

@burkeholland

Copy link
Copy Markdown
Contributor

Introduced a new document outlining best practices for building, structuring, and maintaining Next.js applications. This guide is intended for LLMs and developers to ensure code quality, maintainability, and scalability, covering project structure, component integration, naming conventions, API routes, and general best practices.

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

This is an opinionated instructions file for NextJS apps that is based on research of "best practices" as of July, 2025.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes

Aaron Powell is a legend.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Introduced a new document outlining best practices for building, structuring, and maintaining Next.js applications. This guide is intended for LLMs and developers to ensure code quality, maintainability, and scalability, covering project structure, component integration, naming conventions, API routes, and general best practices.
Copilot AI review requested due to automatic review settings July 22, 2025 19:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 adds a new Next.js best practices instruction file targeting LLMs and developers for 2025. The document provides comprehensive guidelines for building modern Next.js applications using the App Router, covering project structure, component patterns, naming conventions, API design, and general development practices.

Key changes include:

  • Introduction of a structured Next.js instruction document with current best practices
  • Emphasis on App Router over legacy Pages Router approach
  • Specific guidance on Server/Client Component integration patterns
  • Updated README.md to include the new instruction file

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
instructions/nextjs.instructions.md New comprehensive Next.js best practices guide covering project structure, component patterns, API routes, and development standards
README.md Added table entry for the new Next.js instructions file with installation links
Comments suppressed due to low confidence (1)

README.md:53

  • The description '(2025) specific coding standards and best practices' is incomplete and unclear. It should be more descriptive, such as 'Next.js specific coding standards and best practices for 2025' to match the content and purpose of the instruction file.
| [Next.js Best Practices for LLMs (2025)](instructions/nextjs.instructions.md) | (2025) specific coding standards and best practices | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fnextjs.instructions.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fnextjs.instructions.md) |

Comment thread instructions/nextjs.instructions.md
@codemillmatt codemillmatt merged commit c16f478 into github:main Jul 24, 2025
2 checks passed
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.

3 participants