Skip to content

Commit

Permalink
Merge pull request #41 from loopline-systems/feature/35-add-contribut…
Browse files Browse the repository at this point in the history
…ing-md

add contributing.md - fix #35
  • Loading branch information
stefanjudis committed Oct 6, 2015
2 parents e0fdb7f + 4fffd84 commit c3b4677
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# .editorconfig for electron-builder
#
# More info inside CONTRIBUTING.md

# For all files in this project:
# - 2-space soft tabs
# - All files end with a line-break
# - Trim trailing whitespace
[*]
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# electron-builder

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

Before you file an issue or make a pull request please check these points:

## Needed issue information

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
- packager.json
- log of the terminal output
- node version
- npm version

## Pull requests notes

### Editor settings
- please set up your editor to use two spaces
- remove spaces at line endings or empty lines
- make sure all files end with one empty line

### Coding style

#### I really like spaces, because I think they improve the readability a lot. Please try to keep that in mind.

To check that your contributions match the given coding style make sure `npm test` passes.
We use [ESLint](http://eslint.org/) to guarantee a consistent coding style.

#### Please try to stick to line max character number of 80.

I know that it is sometimes unavoidable to go over it. But function arguments and long if-conditions can include line breaks. ;)

#### Please don't forget to add JSDoc to every new implemented function.
6 changes: 3 additions & 3 deletions lib/osx.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

'use strict';

var fs = require( 'fs' );
var path = require( 'path' );
var os = require( 'os' );
var fs = require( 'fs' );
var path = require( 'path' );
var os = require( 'os' );

/**
* Prototype for the osx installer builder
Expand Down

0 comments on commit c3b4677

Please sign in to comment.