Skip to content

Commit

Permalink
docs: improve CONTRIBUTING.md (#380)
Browse files Browse the repository at this point in the history
This PR adds a Contributing section to the README and descriptive text for running Fiddle from source in CONTRIBUTING.md.
  • Loading branch information
natjng authored May 12, 2020
1 parent f3e847d commit 30ba9fb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,27 @@ Here are some things to keep in mind as you file pull requests to fix bugs, add

### Running Fiddle From Source

1. Clone the Electron Fiddle repository locally.

```sh
git clone https://github.com/electron/fiddle.git
```

2. Change directory to where Fiddle has been cloned.

```sh
git clone https://github.com/electron/fiddle
cd fiddle
```

3. Install dependencies.

```sh
npm install
```

4. Start Fiddle and Explore!

```sh
npm start
```

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ fiddle has grown up, export it as a project with or without
[electron-forge][electron-forge]. Then, use your favorite editor and take on
the world!

## Contributing

Electron Fiddle is a community-driven project that welcomes all sorts of contributions. Please check out our [Contributing Guide](https://github.com/electron/fiddle/blob/master/CONTRIBUTING.md) for more details.

## License

[MIT, please see the LICENSE file for full details](https://github.com/electron/fiddle/blob/master/LICENSE.md).
Expand Down

0 comments on commit 30ba9fb

Please sign in to comment.