Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheu authored Nov 21, 2024
1 parent 5c6a1c9 commit 14f7ecf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Block Editor Components - Contribution Guide

## Local Development

**NOTE: This workflow doesn't seem to actually be working**

You can contribute to Block Editor Components whilst working on a project that is using it with [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link).

Setting this up is a two-part process.
Expand Down Expand Up @@ -44,7 +46,9 @@ When you're done, you can unlink the package by running the following:
npm unlink @humanmade/block-editor-components
```

**Note on usage with `@humanmade/webpack-helpers`:** You may hit eslint errors trying to build your assets when linked to a local copy of this. As a workaround, you need to restrict eslint to the current project directory when configuring your webpack build. Do this by filtering the loader options.
**Note on usage with `@humanmade/webpack-helpers`:** You may hit errors trying to build your assets when linked to a local copy of this.

For ESLint errors you can work around by restricting eslint to the current project directory when configuring your webpack build. Do this by filtering the loader options.

```
const path = require( 'node:path' );
Expand Down

0 comments on commit 14f7ecf

Please sign in to comment.