Each Vaadin element has it's own GitHub repository, where development is done. The vaadin-core-element project is just a top-level bundle without actual production code.
Familiarize yourself with the code and try to follow the same syntax conventions to make it easier for us to accept your pull requests.
The following instructions are common for all Vaadin core elements. Replace vaadin-combo-box with any other element in the following examples. Check the element readmes for any special development notes.
- Clone the element project from GitHub:
$ git clone https://github.com/vaadin/vaadin-combo-box.git$ npm install -g bowerIf you encounter permission issues when running
npmsee the article about fixing npm permissions on npmjs.com
- Use Bower to install the dependencies of the element:
$ cd vaadin-combo-box
$ bower install$ npm install -g polyserve- Start a local server in the project root directory:
$ cd vaadin-combo-box
$ polyserve- Open the following URLs in your browser:
- Demo: http://localhost:8080/components/vaadin-combo-box/demo/
- Generated API documentation: http://localhost:8080/components/vaadin-combo-box/
Install Web Component Tester using npm:
$ npm install -g web-component-testerTests can be run with the wct task from the element directory:
$ cd vaadin-combo-box
$ wctYou can also run and debug the tests manually:
$ cd vaadin-combo-box
$ polyserve- Open http://localhost:8080/components/vaadin-combo-box/test/ in your browser.
You should include new tests in your pull requests if you add features to the elements or if you are fixing a bug.
We follow the same style guide as Polymer.
When you send a pull request to any of our repositories, you get an automated comment response about the CLA. It will notify you if you haven’t signed the CLA yet, and in that case instructions how to do it. You need to do this once per earch repository. Before we can accept any of your code contributions, you need to sign the CLA.