Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,26 @@ Tips:

- Use lowercase.
- Avoid long branch names.
- Be specific but not overly detailed.
- 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.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading