Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.45 KB

Contributing

Like most open source projects, we ask that you fork the project and issue a pull request with your changes.

We encourage small change pull requests, the smaller the change the quicker and easier it is merged.

Dependencies

To build this locally, you'll need to install:

Workflow

  1. Fork the project
  2. Clone down your fork git clone git://github.com/<username>/polyfill.git
  3. Setup your 'upstream' git remote add upstream https://github.com/skyglobal/polyfill.git
  4. Create a topic branch to contain your change git checkout -b feature-my-feature
  5. Place any new polyfills into src
  6. Make sure CHANGELOG.md includes a summary of your changes in a new version number heading
  7. Make sure you are still up to date with master git pull upstream master
  8. If necessary, rebase your commits into logical chunks, without errors.
  9. Push the branch up git push origin my-awesome-feature
  10. Create a pull request and describe what your change does and the why you think it should be merged.

If you would like the feature to go live sooner, mention this in the comments/commit. We will provide a temporary live url that will allow you to carry on without getting blocked.

Test Your Changes

You will need to test these manually

Releasing (admin only)

Bump the version with the npm version command, then see https://snap-ci.com/skyglobal/polyfill/branch/master