Skip to content

Commit f1ee387

Browse files
committed
docs(contributing): add instructions to generate github token
1 parent 534a617 commit f1ee387

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,15 @@ Start by ensuring that you have Node.js installed and forking the repository:
1313
- Fork the **webpack.js.org** repo from [the main repository][2].
1414
- `git clone <your-clone-url> && cd webpack.js.org`
1515

16+
Some operations in the build process require a GitHub token. To create and export one:
17+
18+
- Go to [GitHub Personal Access Tokens](https://github.com/settings/personal-access-tokens) and generate a new token with the repo and workflow scopes.
19+
- Export it in your terminal before running build or fetch commands:
20+
1621
Once you are in the project directory, run the following commands:
1722

1823
- `yarn` to pull all dependencies.
19-
- `yarn build` to create a production version of the site.
24+
- `export GITHUB_TOKEN=<your-token-here> yarn build` to create a production version of the site.
2025
- `yarn start` to develop on a local webpack-dev-server: [localhost:3000][3].
2126

2227
> NOTE: run `yarn fetch-repos` and then `yarn fetch` before running `yarn start` command for the first time

0 commit comments

Comments
 (0)