Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.86 KB
Raw

Contributing to Electron API Demos

JavaScript Standard Style

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

See the documentation for information on how this project works.

Code Style & ES6

This project uses the JavaScript Standard style and limited E6 syntax.

Because this project is intended for beginners we stick to mostly vanilla JavaScript. One of the features we want illustrate about Electron, however, is that you can use most of ES6 out of the box. To that end, in this project we use these parts of ES6:

Pull Requests and Issues

Tips for making an easier-to-reivew contribution:

  • Please provide a description.
  • Include screenshots and animated GIFs whenever possible.
  • Use short, present tense commit messages.

Releasing

Releases are created by the core team using the following steps:

  1. Check your dependencies: rm -rf node_modules && npm install
  2. Make sure tests are passing: npm run test
  3. Increment the major, minor or patch version in package.json
  4. Prepare the release: npm run prepare-release
  • This packages and signs all the assets.
  1. Release! npm run release
  • This creates the release on GitHub.com and uploads the assets.