Skip to content

Commit 32f5836

Browse files
byzykmontogeek
authored andcommitted
chore(site) Add package-lock to gitignore, add note about yarn (#2256)
* prevent package-lock * add(contributiong): yarn note
1 parent f870f27 commit 32f5836

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Start by ensuring you have Node installed and forking the repository:
1616

1717
Once you are in the project directory, run the following commands:
1818

19-
- `npm install` to pull all dependencies.
19+
- `npm install` to pull all dependencies. Make sure to check notes below if you prefer Yarn.
2020
- `npm run build` to create a production version of the site.
2121
- `npm start` to develop on a local webpack-dev-server: [localhost:3000][3].
2222
- `npm run fetch` to retrieve external documentation/data.
@@ -30,6 +30,8 @@ See the `package.json` for the full list of `scripts`.
3030
3131
> Note that a __Python version between v2.5.0 and 3.0.0__ is required for the [proselint][12] dependency.
3232
33+
> Although __Yarn__ is not required to work with webpack docs, the core team is using it more extensively. If you prefer to use Yarn make sure you [got it installed][13] and run `yarn` to pull all dependencies, `yarn build` to build the project, or `yarn start` to start development server.
34+
3335
> On Debian and Ubuntu operating systems you may have to use `node >= 7.0.0` to avoid build errors with `node-sass`. Please note that we don't officially support building on these systems.
3436
3537

@@ -125,3 +127,4 @@ any time spent fixing typos or clarifying sections in the documentation.
125127
[10]: http://conventionalcommits.org/
126128
[11]: https://github.com/conventional-changelog/standard-version
127129
[12]: https://github.com/amperser/proselint
130+
[13]: https://yarnpkg.com/lang/en/docs/install

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ starter-kits-data.json
99
.idea
1010
.DS_Store
1111
yarn-error.log
12+
package-lock.json

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

0 commit comments

Comments
 (0)