You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-19Lines changed: 18 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,22 +65,21 @@ If you've completed all of these steps the core team will do its best to respond
65
65
66
66
Though the aim of the Polymer library is to allow lots of flexibility and not get in your way, we work to standardize our elements to make them as toolable and easy to maintain as possible.
67
67
68
-
All elements should follow the [Polymer element style guide](http://polymerelements.github.io/style-guide/), which defines how to specify properties, documentation, and more. It's a great guide to follow when building your own elements as well, for maximum standardization and toolability. For instance, structuring elements following the style guide will ensure that they work with the [`iron-component-page`](https://github.com/polymerelements/iron-component-page) element, an incredibly easy way to turn any raw element directly into a documentation page.
68
+
All elements should follow the [Polymer element style guide](https://www.polymer-project.org/3.0/docs/tools/documentation), which defines how to specify properties, documentation, and more. It's a great guide to follow when building your own elements as well, for maximum standardization and toolability. For instance, structuring elements following the style guide will ensure that they work with the [`iron-component-page`](https://github.com/polymerelements/iron-component-page) element, an incredibly easy way to turn any raw element directly into a documentation page.
69
69
70
70
#### Contributing Code to the Polymer library
71
71
72
-
We follow the most common javascript and HTML style guidelines for how we structure our code - in general, look at the code and you'll know how to contribute! If you'd like a bit more structure, the [Google JavaScript Styleguide](https://google.github.io/styleguide/javascriptguide.xml) is a good place to start.
72
+
We follow the most common JavaScript and HTML style guidelines for how we structure our code - in general, look at the code and you'll know how to contribute! If you'd like a bit more structure, the [Google JavaScript Styleguide](https://google.github.io/styleguide/javascriptguide.xml) is a good place to start.
73
73
74
74
Polymer also participates in Google's [Patch Rewards Program](https://www.google.com/about/appsecurity/patch-rewards/), where you can earn cold, hard cash for qualifying security patches to the Polymer library. Visit the [patch rewards page](https://www.google.com/about/appsecurity/patch-rewards/) to find out more.
75
75
76
76
## Unit tests
77
77
78
-
All Polymer projects use [`web-component-tester`](https://github.com/Polymer/web-component-tester) for unit tests.
79
-
The [`polyserve`](https://github.com/PolymerLabs/polyserve) utility is helpful for running tests in the browser.
78
+
All Polymer projects use [`polymer-cli`](https://github.com/Polymer/tools/tree/master/packages/cli) for unit tests.
80
79
81
-
For maximum flexibility, install `web-component-tester` and `polyserve` locally:
80
+
For maximum flexibility, install `polymer-cli` locally:
82
81
83
-
npm install -g polyserve web-component-tester
82
+
npm install -g polymer-cli
84
83
85
84
### Running the Polymer library unit tests
86
85
@@ -90,39 +89,39 @@ To run the Polymer library unit tests:
90
89
91
90
2. Install the dependencies:
92
91
93
-
npm install && bower install
92
+
npm install
94
93
95
94
3. Run the tests:
96
95
97
96
npm test
98
97
99
-
Or if you have `web-component-tester` installed locally:
98
+
Or if you have `polymer-cli` installed locally:
100
99
101
-
wct
100
+
polymer test --npm
102
101
103
102
To run individual test suites:
104
103
105
104
<code>npm test <var>path/to/suite</var></code>
106
105
107
106
Or:
108
107
109
-
<code>wct <var>path/to/suite</var></code>
108
+
<code>polymer test --npm <var>path/to/suite</var></code>
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Web Components are now implemented natively on Safari and Chrome (~70% of instal
32
32
* You can also save [this HTML file](https://gist.githubusercontent.com/kevinpschaaf/8a5acbea7b25d2bb5e82eeea2b105669/raw/c3a86872f07603e2d0ddae736687e52a5c8c499f/index.html) to a local file and run it in any browser that supports [JavaScript Modules]((https://caniuse.com/#search=modules)).
33
33
34
34
* When you're ready to use Polymer in a project, install it via [npm](https://www.npmjs.com/). To run the project in the browser,
35
-
a module-compatible toolchain is required. We recommend installing the [Polymer CLI](https://github.com/Polymer/polymer-cli) to and using its development server as follows.
35
+
a module-compatible toolchain is required. We recommend installing the [Polymer CLI](https://github.com/Polymer/tools/tree/master/packages/cli) to and using its development server as follows.
36
36
37
37
1. Add Polymer to your project:
38
38
@@ -42,11 +42,11 @@ Web Components are now implemented natively on Safari and Chrome (~70% of instal
42
42
43
43
1. Install the Polymer CLI:
44
44
45
-
```npm i -g polymer-cli@next```
45
+
```npm i -g polymer-cli```
46
46
47
47
1. Run the development server and open a browser pointing to its URL:
48
48
49
-
```polymer serve```
49
+
```polymer serve --npm```
50
50
51
51
> Polymer 3.0 is published on [npm](https://www.npmjs.com/package/@polymer/polymer) using JavaScript Modules.
52
52
This means it can take advantage of the standard native JavaScript module loader available in all current major browsers.
0 commit comments