Contributing
We welcome contributions from all team members! If you have suggestions for new best practices, improvements to existing ones, or additional resources, please follow these steps:
Prepare Your Changes
Fork the Repository
Create a fork of the main repository to your GitHub account. This allows you to make changes without affecting the original codebase.
On the main repository page, click the “Fork” button in the upper right.
Clone Your Fork Locally
Clone the forked repository to your local machine to work on it.
Create a new branch
Always create a new branch for your feature, bug fix, or improvement. This keeps the main branch clean and allows for easier collaboration.
git checkout -b feature/my-awesome-featureAdd or update Markdown files
Follow coding standards and best practices as you develop your code. Ensure that your code is easy to read and maintain.
Before contributing, we encourage you to review our Markdown Best Practices Document.
Testing
Before submitting your PR, thoroughly test your code to ensure it functions as expected. Consider edge cases and input validations.
Prepare the Pull Request
Follow our code review author guide to prepare your pull request. This includes writing a clear and concise title, providing a detailed description of the changes made, and including any relevant links to issues or tickets.
We encourage you to read our Code Review Document before submitting your pull-request.
Project Structure
This repository follows a simple structure powered by Nextra, using Next.js App Router . The main content is organized into Markdown files, which are easy to read and edit.
apps/web/ # Main application directory
├── app/
│ ├── page.mdx # Homepage
│ ├── layout.mdx # Main layout
│ ├── about/
│ │ ├── page.mdx # About page
│ ├── docs/
│ │ ├── page.mdx # Docs homepage
│ │ └── code-review/page.mdx # Code review section
│ └── ...
├── public/ # Static assets like images
├── next.config.ts # Site-wide Nextra config
├── package.json
└── ...