diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70eaf70..db23f0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,4 +84,26 @@ Tips: - Use lowercase. - Avoid long branch names. -- Be specific but not overly detailed. \ No newline at end of file +- Be specific but not overly detailed. + +## Development Environment Setup + +After cloning the repository, you'll need to configure your local development environment: + +### 1. Install Dependencies + +```bash +npm install +``` + +### 2. Configure Development Directory + +The repository includes a `dev/` directory with test files and examples. To prevent your local changes to these files from being committed to the repository, run: + +```bash +npm run setup +``` + +This command configures Git to ignore future changes to files in the `dev/` directory while keeping the original files in the repository for all contributors to use. + +**Note:** You only need to run this once after cloning the repository. diff --git a/package.json b/package.json index 1a364c9..70540e5 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,8 @@ "start": "webpack serve --config ./webpack.dev.js", "prepack": "npm run build", "lint": "eslint .", - "format": "prettier --write ." + "format": "prettier --write .", + "setup": "find dev/ -type f -exec git update-index --skip-worktree {} \\; && echo 'Dev environment configured: changes to dev/ files will be ignored by Git'" }, "repository": { "type": "git",