Skip to content
This repository was archived by the owner on Mar 13, 2018. It is now read-only.

Commit 1d0aa74

Browse files
committed
Merge pull request #16 from hqmq/contributing
Update instructions for newbies like me to contribute.
2 parents ea120c6 + 0c6af8c commit 1d0aa74

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,33 @@ Other projects require a similar agreement: jQuery, Firefox, Apache, Node, and m
2121

2222
Here's an easy guide that should get you up and running:
2323

24-
1. Fork the project on github and pull down your copy.
25-
> replace the {{ username }} with your username and {{ repository }} with the repository name
24+
1. Fork the project on github
25+
2. Pull down the polymer-all project.
2626

27-
git clone git@github.com:{{ username }}/{{ repository }}.git --recursive
27+
git clone git@github.com:Polymer/polymer-all --recursive
2828

29-
Note the `--recursive`. This is necessary for submodules to initialize properly. If you don't do a recursive clone, you'll have to init them manually:
30-
31-
git submodule init
32-
git submodule update
33-
34-
2. Development happens on the `master` branch. Get yourself on it!
29+
3. Go to the polymer-elements directory and switch it to point to your origin.
3530

31+
git remote remove origin
32+
git remote add origin git@github.com:{{ username }}/{{ repository }}
33+
git fetch origin
3634
git checkout master
3735

36+
4. Pull down node dependencies. In your polymer-elements directory run 'npm install' this will pull down the tools used for executing the test.
37+
3838
That's it for the one time setup. Now you're ready to make a change.
3939

40+
## Running the tests
41+
42+
To run the tests make sure you have a webserver running with its docroot pointing to the polymer-all directory. Then navigate to /polymer-elements/test/runner.html
43+
44+
For Example:
45+
46+
cd polymer-all
47+
ruby -rwebrick -e'WEBrick::HTTPServer.new(:Port => 4000, :DocumentRoot => Dir.pwd).start'
48+
49+
Then in your browser open: http://localhost:4000/polymer-elements/test/runner.html
50+
4051
## Submitting a pull request
4152

4253
We iterate fast! To avoid potential merge conflicts, it's a good idea to pull from the main project before making a change and submitting a pull request. The easiest way to do this is setup a remote called `upstream` and do a pull before working on a change:

0 commit comments

Comments
 (0)