etcher/docs/CONTRIBUTING.md

Contributing Guide

Thanks for your interest in contributing to this project! This document aims to serve as a friendly guide for making your first contribution.

High-level Etcher overview

Make sure you checkout our ARCHITECTURE.md guide, which aims to explain how all the pieces fit together.

Prerequisites

• NodeJS.
• Bower.
• Gulp.

Running locally

• Install NodeJS.

Sadly we need to enforce the same NodeJS version that the Electron version we use is running to avoid module version mismatches when building native dependencies (electron-rebuild doesn't seem to be enough).

• Clone the repository.

git clone https://github.com/resin-io/etcher
cd etcher

• Install dependencies.

Please make use of the following scripts to install dependencies rather than simply running npm install given that we need to do extra configuration to make sure native dependencies are correctly compiled for Electron, otherwise the application might not run successfully.

• OS X

./scripts/build/darwin.sh install

• GNU/Linux

./scripts/build/linux.sh install <x64|x86>

• Windows

.\scripts\build\windows.bat install <x64|x86>

• Run the GUI application.

npm start

• Run the CLI application.

node bin/etcher

Developing

We rely on gulp to provide an automated developing workflow in which your changes will automatically be detected and the necessary resources will be rebuilt for you.

First make sure you have gulp installed as a global dependency:

$ npm install -g gulp

Run the watch task to initialise the build system. We encourage to have this command running in the background all the time as you develop, and check the output from time to time, since it'll let you know of any issues and/or warnings in your changes:

$ gulp watch

We make use of EditorConfig to communicate indentation, line endings and other text editing default. We encourage you to install the relevant plugin in your text editor of choice to avoid having to fix any issues during the review process.

Testing

In order to avoid inaccurate results, the test suites run in a real Electron instance each in the respective process. This means that running the test suite is not a cheap operation and therefore we decided to not run it by default in the watch gulp task to not disrupt the user development workflow.

To run the test suite, run the following command:

npm test

Given the nature of this application, not everything can be unit tested. For example:

• The writing operating on real raw devices.
• Platform inconsistencies.
• Style changes.
• Artwork.

We encourage our contributors to test the application on as many operating systems as they can before sending a pull request.

The test suite is run automatically by CI servers when you send a pull request.

Sending a pull request

We make use of commitizen to ensure certain commit conventions, since they will be used to auto-generate the CHANGELOG. The project already includes all necessary configuration, so you only have to install the commitizen cli tool (npm install -g commitizen) and commit by executing git cz, which will drive you through an interactive wizard to make sure your commit is perfectly crafted according to our guidelines.

When sending a pull request, consider the following guidelines:

• Write a concise commit message explaining your changes.

• If applies, write more descriptive information in the commit body.

• Mention the operating systems with the corresponding versions in which you tested your changes.

• If your change affects the visuals of the application, consider attaching a screenshot.

• Refer to the issue/s your pull request fixes, so they're closed automatically when your pull request is merged.

• Write a descriptive pull request title.

• Squash commits when possible, for example, when commiting review changes.

Before your pull request can be merged, the following conditions must hold:

• The linter doesn't throw any warning.

• All the tests passes.

• The coding style aligns with the project's convention.

• Your changes are confirmed to be working in recent versions of the operating systems we support.

Don't hesitate to get in touch if you have any questions or need any help!