You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# 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
64
69
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.
67
72
68
-
# Test just the things in the webpack package
69
-
yarn test --match=webpack
73
+
### Running the Tests
70
74
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
73
80
```
74
81
75
82
## Filing Pull Requests
76
83
77
84
Here are some things to keep in mind as you file pull requests to fix bugs, add new features, etc.:
78
85
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.
82
89
* Unless it's impractical, please write tests for your changes. This will help us so that we can
83
90
spot regressions much easier.
84
91
* 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
87
94
adding a new feature, think about whether it is appropriate to go into a separate Node module,
88
95
and then be integrated into this project.
89
96
* 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.
94
98
* If you are continuing the work of another person's PR and need to rebase/squash, please retain the
95
99
attribution of the original author(s) and continue the work in subsequent commits.
Copy file name to clipboardExpand all lines: README.md
+15-32Lines changed: 15 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ jump right in to Electron development.
21
21
:building_construction:
22
22
23
23
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).
25
25
26
26
----
27
27
@@ -35,16 +35,9 @@ are looking for the 5.x series (the version currently published to NPM), please
35
35
36
36
# Getting Started
37
37
38
-
**Note**: Electron Forge requires Node 6 or above, plus git installed.
38
+
**Note**: Electron Forge requires Node 8 or above, plus git installed.
39
39
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
0 commit comments