From 911e9a7ee03d2afba117f1ab66c196493502856a Mon Sep 17 00:00:00 2001 From: web-padawan Date: Thu, 8 Mar 2018 15:15:33 +0200 Subject: [PATCH] Update development instructions and links --- DEVELOPMENT.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 17b303b..8ef1a55 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -4,11 +4,11 @@ Each Vaadin component has it's own GitHub repository, where development is done. 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 components. **Replace `vaadin-combo-box` with any other element in the following examples**. Check the element readmes for any special development notes. +The following instructions are common for all Vaadin components. **Replace `vaadin-combo-box` with any other component in the following examples**. Check the component readmes for any special development notes. ### Getting the code -1. Clone the element project from GitHub: +1. Clone the component project from GitHub: ```shell $ git clone https://github.com/vaadin/vaadin-combo-box.git @@ -24,7 +24,7 @@ The following instructions are common for all Vaadin components. **Replace `vaad > If you encounter permission issues when running `npm` see the article about [fixing npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on npmjs.com -4. Use Bower to install the dependencies of the element: +4. Use Bower to install the dependencies of the component: ```shell $ cd vaadin-combo-box @@ -33,17 +33,17 @@ The following instructions are common for all Vaadin components. **Replace `vaad ### Running demos -1. Install [polyserve](https://github.com/PolymerLabs/polyserve) using [npm](https://npmjs.com): +1. Install [Polymer CLI](https://github.com/Polymer/polymer-cli) using [npm](https://npmjs.com): ```shell - $ npm install -g polyserve + $ npm install -g polymer-cli ``` 2. Start a local server in the project root directory: ```shell $ cd vaadin-combo-box - $ polyserve + $ polymer serve --port 8080 ``` 3. Open the following URLs in your browser: @@ -57,7 +57,7 @@ Install [Web Component Tester](https://github.com/Polymer/web-component-tester) $ npm install -g web-component-tester ``` -Tests can be run with the `wct` task from the element directory: +Tests can be run with the `wct` task from the component directory: ```shell $ cd vaadin-combo-box @@ -67,7 +67,7 @@ $ wct You can also run and debug the tests manually: ```shell $ cd vaadin-combo-box -$ polyserve +$ polymer serve --port 8080 ``` - Open http://localhost:8080/components/vaadin-combo-box/test/ in your browser. @@ -75,8 +75,8 @@ You should include new tests in your pull requests if you add features to the co ### Documentation -We follow the same [style guide](http://polymerelements.github.io/style-guide/) as Polymer. +We follow the same [style guide](https://www.polymer-project.org/2.0/docs/tools/documentation) as Polymer. ### Contributor License Agreement -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. +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 each repository. Before we can accept any of your code contributions, you need to sign the CLA. -- 2.39.5