|
| 1 | +# Reack CK | Contributing |
| 2 | + |
| 3 | +## How to Contribute |
| 4 | + |
| 5 | +1. Fork the repository. |
| 6 | +2. Create a new branch for your feature or bug fix. |
| 7 | +3. Make your changes and ensure the code lints without errors. |
| 8 | +4. Write tests if applicable. |
| 9 | +5. Submit a pull request. |
| 10 | + |
| 11 | +## Commands |
| 12 | + |
| 13 | +- `prepare`: Installs Husky. |
| 14 | +- `start`: Starts all applications in parallel, excluding configuration files and application files. |
| 15 | +- `start:apps`: Starts only the individual apps in parallel. |
| 16 | +- `build`: Builds all packages except configuration files, documentation files, and application files. |
| 17 | +- `build:infra`: Builds only the infrastructure configuration. |
| 18 | +- `build:docs`: Builds only the documentation. |
| 19 | +- `build:apps`: Builds only the individual apps. |
| 20 | +- `test`: Sequentially runs all test commands. |
| 21 | +- `test:unit`: Parallelly runs unit tests for all packages. |
| 22 | +- `test:snapshot`: Parallelly runs snapshot tests for all packages. |
| 23 | +- `test:snapshot:update`: Parallelly updates snapshot tests. |
| 24 | +- `lint`: Sequentially runs all lint commands. |
| 25 | +- `lint:style`: Lints all SCSS files. |
| 26 | +- `lint:code`: Lints code for all packages. |
| 27 | +- `lint:code:fix`: Lints and fixes code for all packages in parallel. |
| 28 | +- `lint:typescript`: Lints TypeScript code. |
| 29 | +- `format`: Checks formatting using Prettier. |
| 30 | +- `clean`: Removes build artifacts and coverage reports. |
| 31 | +- `clean:cache`: Removes linting and caching artifacts. |
| 32 | +- `clean:deps`: Removes all node_modules directories. |
| 33 | +- `audit`: Runs security audits for all packages. |
| 34 | +- `todo`: Scans for TODO comments in the project. |
| 35 | + |
0 commit comments