Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (40 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.92 KB

You decided to contribute to this project? Great, thanks a lot for pushing it.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please file issue to report unacceptable behavior.

Pull Requests

To check that your contributions match the project coding style make sure npm test passes.

  1. yarn is required because NPM is not reliable.
  2. git-lfs is required (use git lfs pull to download files when git-lfs was installed after git clone).

To build project: yarn && yarn compile

If you get strange compilation errors, try to remove all node_modules in the project (especially under packages/*).

Git Commit Guidelines

We use semantic-release, so we have very precise rules over how our git commit messages can be formatted.

Documentation

Documentation files located in the /docs.

/docs is deployed to Netlify when next release is marked as latest and available for all users.

Debug Tests

Only IntelliJ Platform IDEs (IntelliJ IDEA, WebStorm) support debug. Please prefer to use 2017.2.

If you use IntelliJ IDEA or WebStorm 2017.2 — ij-rc-producer is used and you can run tests from an editor (just click on Run green gutter icon).

Or you can create Node.js run configuration manually:

  • Ensure that Before launch contains Compile TypeScript.
  • Set Node interpreter to NodeJS 8. NodeJS 8 is required to debug.
  • Set Application Parameters to -t "test name" relative-test-file-name if you want to debug particular test. E.g. 
    -t "extraResources - one-package" globTest.js
  • Set Environment Variables:
    • Optionally, TEST_APP_TMP_DIR to some directory (e.g. /tmp/electron-builder-test) to inspect output if test uses temporary directory (only if --match is used). Specified directory will be used instead of random temporary directory and cleared on each run.

Run Test using CLI

TEST_APP_TMP_DIR=/tmp/electron-builder-test ./node_modules/.bin/jest --env jest-environment-node-debug -t 'assisted' '/oneClickInstallerTest\.\w+$'

where TEST_APP_TMP_DIR is specified to easily inspect and use test build, assisted is the test name and /oneClickInstallerTest\.\w+$ is the path to test file.

Do not forget to execute yarn compile before run.

Issues

When filing an issue please make sure, that you give all information needed.

This includes:

  • description of what you're trying to do
  • package.json
  • log of the terminal output
  • node version
  • npm version
  • on which system do you want to create installers (macOS, Linux or Windows).