You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,21 @@ Start by ensuring that you have Node.js installed and forking the repository:
13
13
- Fork the **webpack.js.org** repo from [the main repository][2].
14
14
-`git clone <your-clone-url> && cd webpack.js.org`
15
15
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:
16
+
> To run the project, you must run scripts that download the website content from GitHub.
17
+
> To avoid hitting rate limits, you'll need to use your GitHub token.
18
+
> The build scripts (`fetch-repo` and `fetch:*` commands) use this token to retrieve repository data,
19
+
> including documentation, examples, and contributors.
20
+
> If you do not have one, you can create it on the [GitHub Personal Access Tokens page](https://github.com/settings/personal-access-tokens).
20
21
21
22
Once you are in the project directory, run the following commands:
22
23
23
24
-`yarn` to pull all dependencies.
24
-
-`export GITHUB_TOKEN=<your-token-here> yarn build` to create a production version of the site.
25
+
-`GITHUB_TOKEN=<your-token-here> yarn fetch-all` - Fetches all updated website content from GitHub.
26
+
-`yarn build` to create a production version of the site.
25
27
-`yarn start` to develop on a local webpack-dev-server: [localhost:3000][3].
26
28
29
+
**Note:** The `fetch` and `fetch-repos` commands must be run before building the site as they populate necessary data for the build process.
30
+
27
31
> NOTE: run `yarn fetch-repos` and then `yarn fetch` before running `yarn start` command for the first time
28
32
29
33
-`yarn fetch` to retrieve external documentation/data.
0 commit comments