Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (47 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 3.09 KB

Contributing

Thank you for considering to contribute! 💬

Bugs 🐛

  1. Search the issue tracker for similar bug reports before submitting a new one.
  2. Specify the version of the library where the bug occurred.
  3. Specify your browser version, operating system, and graphics card
    (e.g. Chrome 0.0.0.0 (64-bit), Windows 0 (64-bit), NVIDIA GTX 0000).
  4. Describe the problem in detail. Explain what happened, and what you expected would happen.
  5. Provide a minimal test case (http://jsfiddle.net) or a link to a live version of your application.
  6. If helpful, include a screenshot. Annotate the screenshot for clarity.

Pull Request Process ✨

When contributing to this repository, please first discuss the change you wish to make with the owners of this repository via the issue tracker. A proposed change should be focused and concise. Do not include generated build files in your commits.

  1. Create a feature branch.
  2. Implement your patch or feature on that branch. Maintain the existing coding style.
  3. Lint and test your changes.
  4. Add unit tests for any new or changed functionality.
  5. Navigate to your fork on Github, select your feature branch and create a new Pull Request.
  6. Once your PR has been merged, you can safely remove your feature-branch.

Development 🔧

This project contains scripts that will help you during development. All scripts can be executed with npm run [script]. The following table provides an overview of the most important scripts:

Task Description
lint Checks source files for syntax errors
build Generates the final bundles
ava Runs unit tests

Note: Setting NODE_ENV to production enables source code transpilation and minification which considerably slows down the build process.

Testing ✔️

First, install the http-server using npm install -g http-server to conveniently run things locally.

Navigate to the project's root folder and start the server with the command hs. Open your web browser and navigate to http://localhost:8080/demo/index.debug.html. Please note that the default index.html will load the minified demo bundle which is not desirable during development.

Hint: Open the development tools in your browser and make sure that the browser cache is disabled while it's open.

Keeping Things Up-To-Date ⌛

Don't merge new changes from upstream into your feature branch. Instead, use rebase to replay all of your commits on top of the latest code base:

git checkout master
git pull upstream master
git checkout my-feature
git rebase master

Git will guide you through the process of resolving conflicts. This operation is similar to merging, except you're in fact rewriting your local history. After rebasing, you'll need to use git push --force my-feature.

You can add more commits to your feature branch after you created the PR. This means that you can change things later if necessary.