[Toolkit] Add CONTRIBUTING.md #3161
Conversation
carsonbot
added
Documentation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a dedicated CONTRIBUTING.md file for the Symfony UX Toolkit component and improves the main repository's CONTRIBUTING.md with clearer documentation and enhanced setup instructions.
- Adds comprehensive contributing guidelines specific to the UX Toolkit, including kit structure, development setup, and testing workflows
- Enhances the main CONTRIBUTING.md with better formatting, clearer tool descriptions, and improved installation instructions
- Improves consistency and readability throughout the documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Toolkit/CONTRIBUTING.md | New contributing guide for the Toolkit component with instructions for setup, kit structure, and testing |
| CONTRIBUTING.md | Enhanced main contributing guide with clearer tool descriptions, improved formatting, and better installation instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```shell | ||
| # With GitHub CLI https://cli.github.com/ | ||
| $ gh repo clone <USERNAME>/symfony-ux symfony-ux |
There was a problem hiding this comment.
The repository name should be 'ux' not 'symfony-ux'. The correct command should be gh repo clone <USERNAME>/ux symfony-ux to clone the fork of the symfony/ux repository.
| $ gh repo clone <USERNAME>/symfony-ux symfony-ux | |
| $ gh repo clone <USERNAME>/ux symfony-ux |
| - **[Composer](https://getcomposer.org/download/)** - PHP dependency manager | ||
| - **[Node.js](https://nodejs.org/en/download/package-manager) 22.18 or higher** - Required for asset compilation | ||
| - **[Corepack](https://github.com/nodejs/corepack)** - Package manager manager (comes with Node.js 16+) | ||
| - **[PNPM](https://pnpm.io/) 10.16.1 or higher** - JavaScript package manager (installed via Corepack) |
There was a problem hiding this comment.
The minimum version specified here (10.16.1) is more specific than the version mentioned earlier in the original documentation (10.13). This creates an inconsistency. Consider clarifying if 10.16.1 is the actual required minimum version, and if so, this should be consistent throughout the documentation.
| - **[PNPM](https://pnpm.io/) 10.16.1 or higher** - JavaScript package manager (installed via Corepack) | |
| - **[PNPM](https://pnpm.io/) 10.13 or higher** - JavaScript package manager (installed via Corepack) |
Kocal
force-pushed
the
improve-contribution-steps-toolkit
branch
from
038c0c6 to
379e09c
Compare
2 participants
Following #3144 (comment)