Skip to content

Contributing to Fuel UX

adamalex edited this page Oct 14, 2012 · 1 revision

Basic steps

  1. Before writing code, we suggest you search for issues or create a new one to confirm where your contribution fits into our roadmap.
  2. Fork the Fuel UX repo GitHub help
  3. Make your changes, being sure to add unit tests for new or changed functionality
  4. Run grunt to lint, test, and package up the library
  5. Update your fork with the latest code from Fuel UX, merging as necessary
  6. Commit your changes
  7. If your work is not already in a single commit, rebase and squash into a single commit
  8. Push to your GitHub repo, using --force if you have rebased
  9. Submit a pull request GitHub help

More help with squashing git commits

Philosophy for building JavaScript controls

The Bootstrap repo contained an excellent writeup on the design and thinking that went into building Bootstrap controls. Fuel UX follows this same philosophy. Click the link below to read about it.

https://github.com/twitter/bootstrap/blob/5df1e2c00a295c45db7fa75dba333dc9464b128c/js/README.md