# Contributing to Boilerplate

## Bugs, Ideas, & Requests

Please [open issues](https://github.com/imarc/boilerplate-components/issues) on GitHub.

* When reporting bugs, please try to provide the browser, browser version, and your platform with the report.
* When submitting ideas or requests, be as specific as you can, as well as why it should be included within Boilerplate.

As with other GitHub projects, don't submit an issue for support requests and check for existing issues.

## Working on Boilerplate Locally

To work on Boilerplate locally,

1. Clone this repository.
2. Run `npm install` to install its dependencies.
3. Run `npm run dev` to run the front-end build and watch for file changes, and to use Fractal's dev server and view the components within your browser. (Unlike prior versions, this is now a single command.)

While running like this, any changes made to source files will be picked up immediately, as will the addition and deletion of new files.


## Creating Pull Requests

Fork off of the appropriate branch:

* For work on the current, stable version of Boilerplate, fork off of `master`.
* For work on the upcoming or beta version of Boilerplate, fork off of `next`.

Submit a pull request and describe what your code is meant to do and why it should be included in Boilerplate; even better if you can reference articles or reasons for the change.


## Follow Code Conventions

See [CONVENTIONS.](CONVENTIONS.md)


## Versioning

The project loosely follows Semver - however defining what counts as a backwards-incompatible change in a front-end framework is somewhat ambiguous and left to the team's judgement.