-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from loopline-systems/feature/35-add-contribut…
…ing-md add contributing.md - fix #35
- Loading branch information
Showing
3 changed files
with
54 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters