Skip to content

Commit 5fb8e55

Browse files
committed
chore: clean up README and contributing docs
1 parent 54db67a commit 5fb8e55

File tree

2 files changed

+39
-52
lines changed

2 files changed

+39
-52
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,34 +51,41 @@ When changing the API documentation, here are some rules to keep in mind.
5151
For changes to the website ([electronforge.io](https://www.electronforge.io)), please file
5252
issues/pull requests at [its separate repository](https://github.com/MarshallOfSound/electron-forge-docs).
5353

54-
## Running the Tests
54+
## Changing the Code
5555

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

6158
```bash
62-
# Test everything (fast, slow, all packages)
63-
yarn test
59+
npm i -g bolt
60+
git clone https://github.com/electron-userland/electron-forge
61+
cd electron-forge
62+
# Installs all dependencies, don't run "yarn" or "npm install" yourself
63+
bolt
64+
# Builds all the TS code
65+
bolt build
66+
```
67+
68+
### Making Commits
6469

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

68-
# Test just the things in the webpack package
69-
yarn test --match=webpack
73+
### Running the Tests
7074

71-
# Test just the fast things in the core package
72-
yarn test --match=core --fast
75+
The Electron Forge repository has a lot of tests, some of which take a decent
76+
amount of time to run.
77+
78+
```bash
79+
bolt test
7380
```
7481

7582
## Filing Pull Requests
7683

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

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

README.md

Lines changed: 15 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jump right in to Electron development.
2121
:building_construction:
2222

2323
The `master` branch is a rewrite of Electron Forge that will eventually be the 6.x series. If you
24-
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).
24+
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).
2525

2626
----
2727

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

3636
# Getting Started
3737

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

40-
```bash
41-
npm install -g @electron-forge/cli@beta
42-
electron-forge init my-new-app
43-
cd my-new-app
44-
npm start
45-
```
46-
47-
Alternatively, if you have a more recent version of `npm` or `yarn`, you can use
40+
If you have a more recent version of `npm` or `yarn`, you can use
4841
[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b),
4942
or
5043
[`yarn create`](https://yarnpkg.com/blog/2017/05/12/introducing-yarn/).
@@ -59,6 +52,15 @@ cd my-new-app
5952
npm start
6053
```
6154

55+
Alternatively (less recommended):
56+
57+
```bash
58+
npm install -g @electron-forge/cli
59+
electron-forge init my-new-app
60+
cd my-new-app
61+
npm start
62+
```
63+
6264
# Project Goals
6365

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

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

89-
As of Electron Forge 6+ by default we only do vanilla JavaScript but if you want
91+
By default, Electron Forge only runs vanilla (i.e., non-compiled) JavaScript, but if you want
9092
to do some fancy build tool stuff you should check out the [plugins](https://www.electronforge.io/config/plugins)
91-
section of our docs site. We currently have plugins for Webpack, Parcel and
92-
Electron Compile.
93-
94-
# Contributing
95-
96-
Getting the code base running locally requires the `bolt` command installed globally. An example is given below.
97-
98-
```bash
99-
npm i -g bolt
100-
git clone https://github.com/electron-userland/electron-forge
101-
cd electron-forge
102-
# Installs all dependencies, don't run "yarn" or "npm install" yourself
103-
bolt
104-
# Builds all the TS code
105-
bolt build
106-
```
107-
108-
**NOTE:** Please ensure that all changes are committed using semantic commits, we expose a helper `bolt commit`
109-
to make this easier.
110-
111-
For more information you should check out our [Contributing](CONTRIBUTING.md) guide.
93+
section of our docs site. We currently have plugins for Webpack and Electron Compile, and a
94+
[template for Webpack](https://www.electronforge.io/templates/webpack-template).
11295

11396
# Team
11497

0 commit comments

Comments
 (0)