-
-
Notifications
You must be signed in to change notification settings - Fork 333
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CONTRIBUTING.md, initial commit, WIP.
- Loading branch information
1 parent
c68e137
commit f795f1a
Showing
2 changed files
with
57 additions
and
2 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,54 @@ | ||
# Contributing to ember-paper | ||
|
||
## Coordination, communication and community | ||
|
||
Many ember-paper contributor hang out on the [ember-paper channel on slack](https://embercommunity.slack.com/messages/ember-paper/). Not a slack user? [Get your invitation.](https://ember-community-slackin.herokuapp.com/) | ||
|
||
## Coding style | ||
|
||
* ember-paper uses the [ember-suave](https://github.com/DockYard/ember-suave) coding style. | ||
|
||
* Before submitting a pull request, | ||
check for coding style issues with `jscs -c .jscsrc app addon`. | ||
|
||
## Actions | ||
|
||
* Action closures are preferred to strings representing action names. | ||
|
||
* Properties representing an action should be camelCased, e.g. `onClose`, rather than `on-close`. | ||
|
||
## Importing | ||
|
||
* Import the module, then use const object destructing to extract the desired methods. For example, | ||
```javascript | ||
import Ember from 'ember'; | ||
const { computed } = Ember; | ||
``` | ||
|
||
* When the destructured object assignment statement exceeds 80 columns, put each variable it its own line: | ||
```javascript | ||
const { | ||
$, | ||
Mixin, | ||
String: { htmlSafe }, | ||
RSVP: { Promise }, | ||
computed, | ||
on, | ||
inject: { service }, | ||
run: { scheduleOnce } | ||
} = Ember; | ||
``` | ||
* Order the imported variables in order of appearance, or other logical order. | ||
|
||
## Converting components from Angular Material | ||
|
||
* Use an ember-paper name for components. Convert angular elements attributes to ember boolean properties. | ||
```javascript | ||
<md-tabs md-dynamic-height md-border-bottom> | ||
``` | ||
becomes | ||
```javascript | ||
{{paper-tabs dynamicHeight=true borderBottom=true}} | ||
``` | ||
|
||
* Seek to provide feature parity using Angular Material styles, but implemented in an Ember-centric way. |
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