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

Commit

Permalink
Merge pull request #16 from hqmq/contributing
Browse files Browse the repository at this point in the history
Update instructions for newbies like me to contribute.
  • Loading branch information
dfreedm committed Aug 6, 2013
2 parents ea120c6 + 0c6af8c commit 1d0aa74
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,33 @@ Other projects require a similar agreement: jQuery, Firefox, Apache, Node, and m

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

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

git clone [email protected]:{{ username }}/{{ repository }}.git --recursive
git clone [email protected]:Polymer/polymer-all --recursive

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:

git submodule init
git submodule update

2. Development happens on the `master` branch. Get yourself on it!
3. Go to the polymer-elements directory and switch it to point to your origin.

git remote remove origin
git remote add origin [email protected]:{{ username }}/{{ repository }}
git fetch origin
git checkout master

4. Pull down node dependencies. In your polymer-elements directory run 'npm install' this will pull down the tools used for executing the test.

That's it for the one time setup. Now you're ready to make a change.

## Running the tests

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

For Example:

cd polymer-all
ruby -rwebrick -e'WEBrick::HTTPServer.new(:Port => 4000, :DocumentRoot => Dir.pwd).start'

Then in your browser open: http://localhost:4000/polymer-elements/test/runner.html

## Submitting a pull request

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:
Expand Down

0 comments on commit 1d0aa74

Please sign in to comment.