Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

95 lines (73 loc) · 4.35 KB
Raw

Contributing to Electron Forge

Electron Forge is a community-driven project. As such, we welcome and encourage all sorts of contributions. They include, but are not limited to:

We strongly suggest that before filing an issue, you search through the existing issues to see if it has already been filed by someone else.

This project is a part of the Electron ecosystem. As such, all contributions to this project follow Electron's code of conduct where appropriate.

Questions about usage

If you have questions about usage, we encourage you to visit one of the several community-driven sites.

Before opening bug reports/technical issues

Debugging

One way to troubleshoot potential problems is to set the DEBUG environment variable before running electron-forge. This will print debug information from the specified modules. The value of the environment variable is a comma-separated list of modules which support this logging feature. Known modules include:

  • electron-download
  • electron-forge:* (always use this one before filing an issue)
  • electron-osx-sign
  • electron-packager
  • extract-zip
  • get-package-info

We use the debug module for this functionality. It has examples on how to set environment variables if you don't know how.

If you are using npm run to execute electron-forge, run the electron-forge command without using npm run and make a note of the output, because npm run does not print out error messages when a script errors.

Contribution suggestions

We use the label help wanted in the issue tracker to denote fairly-well-scoped-out bugs or feature requests that the community can pick up and work on. If any of those labeled issues do not have enough information, please feel free to ask constructive questions. (This applies to any open issue.)

Documentation changes

When changing the API documentation, here are some rules to keep in mind.

  • The first line:
    • should end with a period
    • should be in imperative mood (e.g., "Create" instead of "Creates")
    • First line should not be the function's "signature"
  • The first word of the first line:
    • should be properly capitalized
    • should not be "This"

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.
  • 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 the package's documentation.
  • One of the philosophies of the project is to keep the code base as small as possible. If you are 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.
  • This project uses git-cz to generate commit messages. To make commits, please run npm run commit.
  • 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.

Release process

  • if you aren't sure if a release should happen, open an issue
  • make sure the tests pass
  • npm run release:(patch|minor|major)
  • create a new GitHub release from the pushed tag with the contents of CHANGELOG.md for that version
  • close the milestone associated with the version if one is open