Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.97 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 the component locally, you'll need to install:

Workflow

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

Running Locally

  • gulp serve : Run server on port 3456

Working with dependencies

If you want to make changes to the bower dependencies, you can clone them down from here and do the following.

  • cd some-bower-dependency/
  • bower link
  • cd hash-manager/
  • bower link some-bower-dependency

Releasing (admin only)

gulp release

This will automatically bump the 'patch' section of the version number.

To bump a different area of the version number you can also use major|minor|patch|prerelease e.g. :

gulp release --version prerelease

Common Errors

S3::putObject *** error! or UnknownEndpoint: Inaccessible host:

This happens whn a connection to the S3 failed to establish. bump and gh-pages would have already executed. Please try the release to cloud only by running:

component release cloud