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

Fuel UX Git and GitHub Conventions

Stephen James edited this page Feb 3, 2015 · 3 revisions
  • Limit commits to as few per pull request as sensible, so that the pull request can be focused.
  • Mention the issue number in the pull request or pull request number within the issue. Once fixed, use the keyword fixes with the issue number to close the issue.
  • Assign yourself or asked to be assigned an issue before working on it.
  • Modify pull request generated defaults to reflect entire pull request. This title may be used in the release notes.
    • Bad: Button group updated
    • Better: Button group font updated
    • Best: Button group's large button font weight decreased
  • Pull request from your own fork. Remember to sync from the upstream.
  • Work on approved for work issues or work "experimentally" with the possibility that the pull request may need to be discussed and modified.
  • Ask for clarification if anything is uncertain or you are unfamiliar with the library. This will allow the maintainers to know what shouldn't be assumed and will help the whole community. Some issues may be stubs without any direction.
  • Please use the imperative verb in commits. Preference of "add" over "added" or "adding."
  • Capitalize the first word and any proper nouns.
  • Limit length first line of commit message to 50 characters.
  • Periods are not needed at the end.
  • Even if you have push rights, do not merge your own pull requests.