Contributing to Fuel UX

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. Please do not commit files within the dist/ folder, but you will still want to run 'grunt' to build the files for any local testing. Project maintainers will run a final build before each release.
7. If your work is not already in a single commit, rebase and squash into a single commit (if possible).
8. Push to your GitHub repo, using --force if you have rebased.
9. Submit a pull request to the latest work-in-progress branch (wip). For help, see GitHub help.
   • Bug fixes: If you are adding a bug-fix or patch for version 3.1.0, then the branch you would submit your pull request to would be 3.1.1 (or 3.1.1-wip). Please review semver.org.
   • New features: If you are planning on making major or significant 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

• Squash Commits with Git
• Interactive Rebasing in WebStorm

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 a similar philosophy.