Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 3.75 KB
Raw

Contributing

We welcome and truly appreciate contribution in all forms - issues, pull requests, questions, or fancy examples of apps/elements build on to of your elements.

Filing bugs

Our team heavily uses Github for all of our software management. We use Github issues to track all bugs and features.

If you find an issue, please do file it on the repository.

We love examples for addressing issues - issues with a Plunkr, jsFiddle, or jsBin will be much easier for us to work on quickly. You can start with this jsbin which sets up the basics to demonstrate a Juicy element.

Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! Please feel free to re-open issues we've closed if there's something we've missed and they still need to be addressed.

Developing the element

If you would like to start to fiddle with element's code, here is the flow we use.

In order to develop it locally we suggest to use polyserve tool to handle bower paths gently.

  1. Go to the repo's directory: cd juicy-html
  2. Install bower & polyserve: $ npm install -g bower polyserve
  3. Install local dependencies: $ bower install
  4. Start development server $ polyserve -p 8000
  5. Open the demo/preview: http://127.0.0.1:8001/components/juicy-html/examples/
  6. Open the test suite: http://localhost:8000/components/juicy-html/test/

Contributing Pull Requests

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Open corresponding issue if needed
  6. Submit a pull request :D

Styleguide

.jscs.json/.jscsrc/package.json to be linked

Unit tests

All Juicy custom elements projects use web-component-tester for unit tests. The polyserve utility is helpful for running tests in the browser.

Running element unit tests from CLI

To run the element unit tests from CLI, you need to:

  1. Install web-component-tester globally: npm install -g web-component-tester
  2. Clone the element repo.
  3. Install the dependencies. bower install
  4. Run the tests: wct

Configuring web-component-tester

By default, web-component-tester runs tests on all installed browsers. You can configure it to run tests on a subset of available browsers, or to run tests remotely using Sauce Labs.

See the web-component-tester README for information on configuring the tool.

Releasing a new version

The release is done from master branch.

  1. Make sure that the browser tests pass in Chrome, Firefox, Edge and IE. This can be done manually or using npm run test (see instructions above).
  2. Call git status to verify that there are no uncommited files in the directory
  3. Call grunt bump:patch, grunt bump:minor or grunt bump:major. This command:
  • increments the version number in the relevant files
  • commits changes to Git with the version number as the commit message
  • creates a Git tag wit the version
  1. Call git push to push the changes to origin master
  2. Call git push --tags to push the tag to origin master
  3. Explain the changes (at least an summary of the commit log) in GitHub Releases.