Skip to content

Commit f55ce5e

Browse files
committed
Merge branch 'release/0.1.0'
2 parents 3ae32cb + d88fd1f commit f55ce5e

File tree

659 files changed

+61369
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

659 files changed

+61369
-0
lines changed

.bowerrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"directory": "bower_components",
3+
"analytics": false
4+
}

.editorconfig

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
8+
[*]
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
indent_style = space
14+
indent_size = 4
15+
16+
[*.js]
17+
indent_style = space
18+
indent_size = 4
19+
20+
[*.hbs]
21+
insert_final_newline = false
22+
indent_style = space
23+
indent_size = 4
24+
25+
[*.css]
26+
indent_style = space
27+
indent_size = 4
28+
29+
[*.html]
30+
indent_style = space
31+
indent_size = 4
32+
33+
[*.{diff,md}]
34+
trim_trailing_whitespace = false

.ember-cli

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
/**
3+
Ember CLI sends analytics information by default. The data is completely
4+
anonymous, but there are times when you might want to disable this behavior.
5+
6+
Setting `disableAnalytics` to true will prevent any data from being sent.
7+
*/
8+
"disableAnalytics": false
9+
}

.github/CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Style/Conventions
2+
3+
### Checking your code
4+
5+
Code style checking is part of the Travis build, and PRs that do not meet the code style guidelines will not be merged. You can run these checks locally with:
6+
`npm run check-style`
7+
8+
### Naming conventions
9+
10+
Please review and adhere to the naming conventions defined [here](http://ember-cli.com/user-guide/#naming-conventions)
11+
12+
### Accessibility
13+
14+
The [ember-a11y](https://www.npmjs.com/package/ember-a11y) addon is a dependency of this addon, and helps facilitate compliance with the guidelines laid out by the [A11y Project](http://a11yproject.com/). This requires one simple change: wherever you would normally use the `{{outlet}}` helper, instead use `{{focusing-outlet}}`. See the project page for more details.
15+
16+
### Internationalization
17+
18+
_(In Progress)_ We plan to use the [ember-i18n](https://github.com/jamesarosen/ember-i18n) addon for internationalization support in all components. The main change required here is that all blocks of text should be wrapped with the `t` helper supplied by this library. Read more here: [https://github.com/jamesarosen/ember-i18n/wiki/Doc:-Translating-Text](https://github.com/jamesarosen/ember-i18n/wiki/Doc:-Translating-Text)
19+
20+
### Components
21+
22+
We will use "pod" style structure for all of the components in this addon. This means when generating component scaffolds with ember-cli you must pass the --pod flag: `ember g component my-component --pod`. Basically components should be structured like:
23+
24+
- addon/components/<name>/
25+
- component.js
26+
- template.hbs
27+
- style.scss (optional)
28+
29+
#### Styling components
30+
31+
Leveraging the [ember-component-css](https://github.com/ebryn/ember-component-css) addon will allow us to bundle [Sass](http://sass-lang.com/) files inside components' pod structure, and will automatically namespace those styles to avoid all possible CSS collisions. This approach will allow for easy overrides and paramterization via top-level Sass variables.
32+
33+
# Testing
34+
35+
36+
## Unit tests
37+
38+
We aim to have near-full test coverage of the code in this addon. That said we want to avoid testing the Ember core or third-party libraries, so some general guidelines for unit tets (minumum requirements):
39+
40+
**Models**
41+
_Do test_:
42+
- helper methods
43+
- custom transforms
44+
45+
**Components/Mixins**
46+
_Do test_:
47+
- methods
48+
- computed values
49+
50+
## Integration tests
51+
52+
Integration tests allow us to see how components behave while actually running in a browser enviornment. [TODO](https://openscience.atlassian.net/browse/EOSF-28)
53+
54+
#### Accessibility checks
55+
56+
We will use the [ember-a11y-testing](https://github.com/trentmwillis/ember-a11y-testing) addon to run a11y checks on all components.
57+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Ticket
2+
3+
# Purpose
4+
5+
# Notes for Reviewers
6+
7+
## Routes Added/Updated
8+
9+

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# See http://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# compiled output
4+
/dist
5+
/tmp
6+
7+
# dependencies
8+
/node_modules
9+
/bower_components
10+
11+
# misc
12+
/.sass-cache
13+
/connect.lock
14+
/coverage/*
15+
/libpeerconnection.log
16+
npm-debug.log
17+
testem.log
18+
19+
config/*.yml

.jshintrc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"predef": [
3+
"server",
4+
"document",
5+
"window",
6+
"-Promise"
7+
],
8+
"browser": true,
9+
"boss": true,
10+
"curly": false,
11+
"debug": false,
12+
"devel": true,
13+
"eqeqeq": true,
14+
"evil": true,
15+
"forin": false,
16+
"immed": false,
17+
"laxbreak": false,
18+
"newcap": true,
19+
"noarg": true,
20+
"noempty": false,
21+
"nonew": false,
22+
"nomen": false,
23+
"onevar": false,
24+
"plusplus": false,
25+
"regexp": false,
26+
"undef": true,
27+
"sub": true,
28+
"strict": false,
29+
"white": false,
30+
"eqnull": true,
31+
"esnext": true,
32+
"unused": true
33+
}

.npmignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/bower_components
2+
/config/ember-try.js
3+
/dist
4+
/tests
5+
/tmp
6+
**/.gitkeep
7+
.bowerrc
8+
.editorconfig
9+
.ember-cli
10+
.gitignore
11+
.jshintrc
12+
.watchmanconfig
13+
.travis.yml
14+
bower.json
15+
ember-cli-build.js
16+
testem.js

.template-lintrc.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/* jshint node:true */
2+
'use strict';
3+
4+
module.exports = {
5+
extends: 'recommended',
6+
7+
rules: {
8+
'block-indentation': 4
9+
}
10+
};

.travis.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
language: node_js
3+
node_js:
4+
- "4.3.2"
5+
6+
sudo: false
7+
8+
cache:
9+
directories:
10+
- node_modules
11+
12+
before_install:
13+
- export PATH=/usr/local/phantomjs-2.0.0/bin:$PATH
14+
- "npm config set spin false"
15+
- "npm install -g npm@^2"
16+
17+
install:
18+
- npm install -g bower
19+
- npm install
20+
- bower install
21+
22+
script:
23+
- npm run check-style && npm test

0 commit comments

Comments
 (0)