Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Contributing to Fuel UX

Stephen James edited this page May 28, 2015 · 16 revisions

Basic steps

Before writing code for a new feature, please search for issues or create a new one to confirm where your contribution fits into our roadmap.

  1. Fork the Fuel UX repository and make your changes. Please add unit tests for new or changed functionality. Unit tests are found in /test.
  2. Run grunt to lint and unit test your changes. Run grunt serve and visit http://localhost:8000/test/fuelux.html for information on failing unit tests.
  3. Sync your fork with the upstream repo.
  4. Commit your changes. Please do not commit files within /dist. Rebase and squash into a single commit if it makes sense to. Please do not commit "WIP", "part 1", "part 2" labeled commits, so that we may keep our history clean and meaningful.
  5. Push to your forked repo and submit a pull request to master. For help, visit GitHub's using pull requests

See our style guide for lint errors/warnings). If you are new to git, please review our git commit conventions

Help with squashing git commits

Philosophy for building JavaScript controls

The Bootstrap repository contained an excellent writeup on the design and thinking that went into building Bootstrap controls. Fuel UX follows a similar philosophy.

Closing issues from pull request merges

How to close an issue from a pull request