Skip to content

Commit 168456d

Browse files
committed
Create contributing.md
1 parent 7c9ef06 commit 168456d

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to Electron API Demos
2+
3+
[![JavaScript Standard Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com)
4+
5+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
6+
7+
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
8+
By participating, you are expected to uphold this code. Please report unacceptable
9+
behavior to [[email protected]](mailto:[email protected]).
10+
11+
## Code Style & ES6
12+
13+
This project uses the [JavaScript Standard](http://standardjs.com) style and limited E6 syntax.
14+
15+
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:
16+
17+
- [`const`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/const)
18+
- [`let`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let)
19+
- [string templates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
20+
21+
## Pull Requests and Issues
22+
23+
Tips for making an easier-to-reivew contribution:
24+
25+
- Please provide a description.
26+
- Include screenshots and animated GIFs whenever possible.
27+
- Use short, present tense commit messages.

0 commit comments

Comments
 (0)