Skip to content

Commit

Permalink
chore: clean up README and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@malept
malept committed Jul 16, 2019
1 parent 54db67a commit 5fb8e55
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 52 deletions.
44 changes: 24 additions & 20 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,34 +51,41 @@ When changing the API documentation, here are some rules to keep in mind.
For changes to the website ([electronforge.io](https://www.electronforge.io)), please file
issues/pull requests at [its separate repository](https://github.com/MarshallOfSound/electron-forge-docs).

## Running the Tests
## Changing the Code

The Electron Forge repository has a lot of tests some mof which take a decent
amount of time to run, if you only want to run the fast tests or just the tests
for a specific package we've provided some helpers to make it easy for you
to do so.
Getting the code base running locally requires the `bolt` command installed globally. An example is given below.

```bash
# Test everything (fast, slow, all packages)
yarn test
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
```

### Making Commits

# Test just the fast things
yarn test --fast
Please ensure that all changes are committed using [semantic commit messages](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
We expose a helper (`bolt commit`) to make this easier.

# Test just the things in the webpack package
yarn test --match=webpack
### Running the Tests

# Test just the fast things in the core package
yarn test --match=core --fast
The Electron Forge repository has a lot of tests, some of which take a decent
amount of time to run.

```bash
bolt test
```

## Filing Pull Requests

Here are some things to keep in mind as you file pull requests to fix bugs, add new features, etc.:

* Travis CI is used to make sure that the project builds packages as expected on the supported
platforms, using supported Node.js versions, and that the project conforms to the configured
coding standards.
* Travis CI and AppVeyor are used to make sure that the project builds packages as expected on the
supported platforms, using supported Node.js versions, and that the project conforms to the
configured coding standards.
* Unless it's impractical, please write tests for your changes. This will help us so that we can
spot regressions much easier.
* If your PR changes the behavior of an existing feature, or adds a new feature, please add/edit
Expand All @@ -87,10 +94,7 @@ Here are some things to keep in mind as you file pull requests to fix bugs, add
adding a new feature, think about whether it is appropriate to go into a separate Node module,
and then be integrated into this project.
* Please **do not** bump the version number in your pull requests, the maintainers will do that.
Feel free to indicate whether the changes require a major, minor, or patch version bump, as
prescribed by the [semantic versioning specification](http://semver.org/).
* This project uses `git-cz` to generate commit messages. To make commits, please run
`npm run commit`.
Feel free to indicate whether the changes are a breaking change in behavior.
* If you are continuing the work of another person's PR and need to rebase/squash, please retain the
attribution of the original author(s) and continue the work in subsequent commits.

Expand Down
47 changes: 15 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jump right in to Electron development.
:building_construction:

The `master` branch is a rewrite of Electron Forge that will eventually be the 6.x series. If you
are looking for the 5.x series (the version currently published to NPM), please view the [5.x branch](https://github.com/electron-userland/electron-forge/tree/5.x).
are looking for the 5.x series (the version currently published to NPM under `electron-forge`), please view the [5.x branch](https://github.com/electron-userland/electron-forge/tree/5.x).

----

Expand All @@ -35,16 +35,9 @@ are looking for the 5.x series (the version currently published to NPM), please

# Getting Started

**Note**: Electron Forge requires Node 6 or above, plus git installed.
**Note**: Electron Forge requires Node 8 or above, plus git installed.

```bash
npm install -g @electron-forge/cli@beta
electron-forge init my-new-app
cd my-new-app
npm start
```

Alternatively, if you have a more recent version of `npm` or `yarn`, you can use
If you have a more recent version of `npm` or `yarn`, you can use
[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b),
or
[`yarn create`](https://yarnpkg.com/blog/2017/05/12/introducing-yarn/).
Expand All @@ -59,6 +52,15 @@ cd my-new-app
npm start
```

Alternatively (less recommended):

```bash
npm install -g @electron-forge/cli
electron-forge init my-new-app
cd my-new-app
npm start
```

# Project Goals

1. Starting with Electron should be as simple as a single command.
Expand Down Expand Up @@ -86,29 +88,10 @@ For Electron Forge documentation and usage you should check out our website:

## How do I use this with `webpack`/`babel`/`typescript`/`random build tool`?

As of Electron Forge 6+ by default we only do vanilla JavaScript but if you want
By default, Electron Forge only runs vanilla (i.e., non-compiled) JavaScript, but if you want
to do some fancy build tool stuff you should check out the [plugins](https://www.electronforge.io/config/plugins)
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.
section of our docs site. We currently have plugins for Webpack and Electron Compile, and a
[template for Webpack](https://www.electronforge.io/templates/webpack-template).

# Team

Expand Down

0 comments on commit 5fb8e55

Please sign in to comment.