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 Apr 24, 2014 · 16 revisions

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 the appropriate grunt tasks lint and test your changes (see the Gruntfile.js for tasks, see our style guide for lint errors/warnings)
  5. Update your fork with the latest code from Fuel UX, merging as necessary
  6. Commit your changes. We suggest only committing the files within the js/ folder for simpler merging, but you'll want to run 'grunt' after commiting to build the files for any local testing.
  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 to the latest working branch. For help, see GitHub help
    • If you're editing something on version 3.1.0, then the branch you submit your pull request to would be 3.1.1 (if your changes are bug fixes).
    • If you're planning on making major or minor changes, please contact the maintainers (@kevinparkerson, @interactivellama, or @vernak2539) and they will help you get the proper working branch created.

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