@nurun-sf/spark-component/CONTRIBUTING.md

A tool for building spark components

# Contributing to Spark

Want to contribute to Spark? Great! Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

## Issues
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue. Please check existing issues first for your issue by searching the open and closed issues. Providing the following information will increase the chances of your issue being dealt with quickly:

* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
* **Motivation for or Use Case** - explain why this is a bug for you
* **Browsers and Operating System** - is this a problem with all browsers or only a specific one?
* **Reproduce the Error** - provide a [reduced test case](https://css-tricks.com/reduced-test-cases/) (using [JS Bin](https://jsbin.com), [JSFiddle](https://jsfiddle.net/), or [CodePen](http://codepen.io/)) or a unambiguous set of steps.
* **Related Issues** - has a similar issue been reported before?
* **Paste error output** or logs in your issue or in a Gist. If pasting them in the issue, wrap it in three backticks so that it renders nicely.
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
  causing the problem (line of code or commit)

If your issue does not contain sufficient information, it may be closed.

## Pull Requests

If you’re able to patch the bug or add the feature yourself – fantastic, make a pull request with the code! We follow a [slightly modified version](https://github.com/odopod/javascript-style-guide) of the Airbnb JavaScript style guide. The linter will tell you if you're not conforming.

* Make your changes in a new git branch:

    ```shell
    git checkout -b my-fix-branch master
    ```

* Create your patch, **including appropriate test cases**.
* If you're adding a feature, make sure to update the **documentation/demos**.
* Build your changes locally to ensure all the tests pass:

    ```shell
    gulp test
    ```

* Push your branch to GitHub:

    ```shell
    git push origin my-fix-branch
    ```

* In GitHub, send a pull request to the `master` branch.
* If we suggest changes then:
  * Make the required updates.
  * Re-run the tests to ensure they are still passing.
  * Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

    ```shell
    git rebase master -i
    git push -f
    ```

That's it! Thank you for your contribution!

#### After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:

* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    ```shell
    git push origin --delete my-fix-branch
    ```

* Check out the master branch:

    ```shell
    git checkout master -f
    ```

* Delete the local branch:

    ```shell
    git branch -D my-fix-branch
    ```

* Update your master with the latest upstream version:

    ```shell
    git pull --ff upstream master
    ```

## Code of Conduct

This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
[code-of-conduct]: http://todogroup.org/opencodeofconduct/#Spark/hello@odopod.com