Skip to content

Commit

Permalink
chore(site) Add package-lock to gitignore, add note about yarn (#2256)
Browse files Browse the repository at this point in the history
* prevent package-lock

* add(contributiong): yarn note
  • Loading branch information
byzyk authored and montogeek committed Jun 21, 2018
1 parent f870f27 commit 32f5836
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Start by ensuring you have Node installed and forking the repository:

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

- `npm install` to pull all dependencies.
- `npm install` to pull all dependencies. Make sure to check notes below if you prefer Yarn.
- `npm run build` to create a production version of the site.
- `npm start` to develop on a local webpack-dev-server: [localhost:3000][3].
- `npm run fetch` to retrieve external documentation/data.
Expand All @@ -30,6 +30,8 @@ See the `package.json` for the full list of `scripts`.
> Note that a __Python version between v2.5.0 and 3.0.0__ is required for the [proselint][12] dependency.
> 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.
> 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.

Expand Down Expand Up @@ -125,3 +127,4 @@ any time spent fixing typos or clarifying sections in the documentation.
[10]: http://conventionalcommits.org/
[11]: https://github.com/conventional-changelog/standard-version
[12]: https://github.com/amperser/proselint
[13]: https://yarnpkg.com/lang/en/docs/install
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ starter-kits-data.json
.idea
.DS_Store
yarn-error.log
package-lock.json
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false

0 comments on commit 32f5836

Please sign in to comment.