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
There are many ways to contribute to the Polymer project! We welcome and truly appreciate contribution in all forms - issues and pull requests to the [main library](https://github.com/polymer/polymer), issues and pull requests to the [elements the Polymer team maintains](https://github.com/polymerelements), issues and pull requests to one of our many [Polymer-related tools](https://github.com/polymer), and of course we love to hear about any Polymer elements that you build to share with the community!
3
+
There are many ways to contribute to Lit! We welcome and truly appreciate contribution in all forms - issues and pull requests to the [main libraries](https://github.com/lit/lit), issues and pull requests to the [lit.dev site](https://github.com/lit/lit.dev), and of course we love to hear about any Lit components that you build to share with the community!
4
+
5
+
## Status of this repository
6
+
7
+
The main LitElement code has been moved into the [Lit monorepo](https://github.com/lit/lit). All new development is happening there. This repository is only for critical updates to `lit-element` 2.x.
4
8
5
9
## Logistics
6
10
7
-
### Communicating with the Polymer team
11
+
### Communicating with the team
8
12
9
13
Beyond GitHub, we try to have a variety of different lines of communication open:
Because of the component-based nature of the Polymer project, we tend to have lots of different repositories. Our main repository for the Polymer library itself is at [github.com/Polymer/polymer](https://github.com/polymer/polymer). File any issues or pull requests that have to do with the core library on that repository, and we'll take a look ASAP.
19
-
20
-
We keep all of the element "product lines" that the Polymer team maintains and distributes in the [PolymerElements](https://github.com/polymerelements) organization. For any element-specific issues or pull requests, file directly on the element's repository, such as the `paper-button` repository at [github.com/polymerelements/paper-button](https://github.com/polymerelements/paper-button). Of course, the elements built by the Polymer team are just a tiny fraction of all the Polymer-based elements out there - catalogs of other web components include [https://www.webcomponents.org/](https://github.com/webcomponents/webcomponents.org) and [component.kitchen](https://component.kitchen).
21
-
22
-
The GoogleWebComponents element product line is maintained by teams all across Google, and so is kept in a separate organization: the [GoogleWebComponents](https://github.com/googlewebcomponents) org. Feel free to file issues and PR's on those elements directly in that organization.
23
-
24
-
We also track each element product line overall in "meta-repos", named as `$PRODUCTLINE-elements`. These include [paper-elements](https://github.com/polymerelements/paper-elements), [iron-elements](https://github.com/polymerelements/iron-elements), [gold-elements](https://github.com/polymerelements/gold-elements), and more. Feel free to file issues for element requests on those meta-repos, and the README in each repo tracks a roadmap for the product line.
17
+
*[Slack channel](https://lit.dev/slack-invite/)
25
18
26
19
### Contributor License Agreement
27
20
@@ -39,11 +32,9 @@ Docs source is in the `docs` folder. To build the site yourself, see the instruc
39
32
40
33
### Filing bugs
41
34
42
-
The Polymer team heavily uses (and loves!) GitHub for all of our software management. We use GitHub issues to track all bugs and features.
35
+
The Lit team heavily uses (and loves!) GitHub for all of our software management. We use GitHub issues to track all bugs and features.
43
36
44
-
If you find an issue, please do file it on the repository. The [lit-element issues](https://github.com/Polymer/lit-element/issues) should be used only for issues on the lit-element library itself - bugs somewhere in the core codebase.
45
-
46
-
For issues with elements the team maintains, please file directly on the element's repository. If you're not sure if a bug stems from the element or the library, air toward filing it on the element and we'll move the issue if necessary.
37
+
If you find an issue, please do file it on the repository. The [lit-element issues](https://github.com/lit/lit-element/issues) should be used only for issues on the lit-element library itself - bugs somewhere in the core codebase.
47
38
48
39
Please file issues using the issue template provided, filling out as many fields as possible. We love examples for addressing issues - issues with a jsBin, Plunkr, jsFiddle, or glitch.me repro will be much easier for us to work on quickly. You can start with [this StackBlitz](https://stackblitz.com/edit/lit-element-example?file=index.js) which sets up the basics to demonstrate a lit-element. If you need your repro to run in IE11, you can start from [this glitch](https://glitch.com/edit/#!/hello-lit-element?path=index.html:1:0), which serves the source via polyserve for automatic transpilation, although you must sign up for a glitch.me account to ensure your code persists for more than 5 days (note the glitch.me _editing environment_ is not compatible with IE11, however the "live" view link of the running code should work).
49
40
@@ -64,31 +55,19 @@ PR's are even better than issues. We gladly accept community pull requests. In g
64
55
65
56
If you've completed all of these steps the core team will do its best to respond to the PR as soon as possible.
66
57
67
-
#### Contributing Code to Elements
68
-
69
-
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.
70
-
71
-
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.
72
-
73
-
#### Contributing Code to the Polymer library
58
+
#### Contributing Code to LitElement
74
59
75
60
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.
76
61
77
-
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.
62
+
Lit 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 Lit library. Visit the [patch rewards page](https://www.google.com/about/appsecurity/patch-rewards/) to find out more.
78
63
79
64
## Unit tests
80
65
81
-
All Polymer projects use [`polymer-cli`](https://github.com/Polymer/tools/tree/master/packages/cli) for unit tests.
82
-
83
-
For maximum flexibility, install `polymer-cli` locally:
84
-
85
-
npm install -g polymer-cli
86
-
87
66
### Running the lit-element unit tests
88
67
89
68
To run the lit-element unit tests:
90
69
91
-
1. Clone the [lit-element repo](https://github.com/polymer/lit-element).
70
+
1. Clone the [lit-element repo](https://github.com/lit/lit-element).
92
71
93
72
2. Install the dependencies:
94
73
@@ -98,45 +77,13 @@ To run the lit-element unit tests:
98
77
99
78
npm test
100
79
101
-
Or if you have `polymer-cli` installed locally:
102
-
103
-
polymer test --npm
104
-
105
80
To run individual test suites:
106
81
107
82
<code>npm test <var>path/to/suite</var></code>
108
83
109
-
Or:
110
-
111
-
<code>polymer test --npm <var>path/to/suite</var></code>
By default, `polymer test` runs tests on all installed browsers. You can configure it
128
-
to run tests on a subset of available browsers, or to run tests remotely using Sauce Labs.
129
-
130
-
See the [`web-component-tester` README](https://github.com/Polymer/tools/tree/master/packages/web-component-tester) for
131
-
information on configuring the tool using by `polymer-cli` to run the tests.
132
-
133
-
### Viewing the source documentation locally
134
-
135
-
You can view the updates you make to the source documentation locally with the following steps.
136
-
Make sure to rerun step 1 after every change you make.
137
-
138
-
1. Run `polymer analyze > analysis.json`
139
-
140
-
1. Run `polymer serve`
87
+
By default, `npm test` runs tests on all installed browsers. You can configure it to run tests on a subset of available browsers, or to run tests remotely using Sauce Labs.
141
88
142
-
1. Open `http://127.0.0.1:PORT/components/polymer/` to view the documentation
89
+
See the [`web-component-tester` README](https://github.com/Polymer/tools/tree/master/packages/web-component-tester) for information on configuring the test runner.
0 commit comments