Skip to content
Permalink
Browse files

docs: add contributing docs

  • Loading branch information
MarshallOfSound committed Nov 17, 2018
1 parent 50a4f06 commit 80259589d52f641d4848894f877c7be2351f2c8e
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
@@ -91,6 +91,25 @@ to do some fancy build tool stuff you should check out the [plugins](https://v6.
section of our docs site. We currently have plugins for Webpack, Parcel and
Electron Compile.

# Contributing

Getting the code base running locally requires the `bolt` command installed globally. An example is given below.

```bash
npm i -g bolt
git clone https://github.com/electron-userland/electron-forge
cd electron-forge
# Installs all dependencies, don't run "yarn" or "npm install" yourself
bolt
# Builds all the TS code
bolt build
```

**NOTE:** Please ensure that all changes are committed using semantic commits, we expose a helper `bolt commit`
to make this easier.

For more information you should check out our [Contributing](CONTRIBUTING.MD) guide.

This comment has been minimized.

Copy link
@malept

malept Nov 17, 2018

Member

CONTRIBUTING.md

This comment has been minimized.

Copy link
@MarshallOfSound

MarshallOfSound Nov 17, 2018

Author Member

That's what I get for writing this on a case insensitive file system


# Team

| <img src="https://s.gravatar.com/avatar/1576c987b53868acf73d6ccb08110a78?s=144" width="144" /> | <img src="https://avatars2.githubusercontent.com/u/11417?s=460&v=4" width="144" /> |

0 comments on commit 8025958

Please sign in to comment.
You can’t perform that action at this time.