Skip to content

Instantly share code, notes, and snippets.

@Leodau

Leodau/CONTRIBUTING.md

Created October 29, 2019 23:24
Show Gist options
  • Save Leodau/54cc6ac7e9518f04544f4f42517e394b to your computer and use it in GitHub Desktop.
Save Leodau/54cc6ac7e9518f04544f4f42517e394b to your computer and use it in GitHub Desktop.
Download ZIP
Contributing guidelines
Raw
CONTRIBUTING.md

🔫 Commit Guidelines

Structure Example :-

type(branch): subject

Example: feat(backoffice): support full game editing

Type :-

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Subject :-

The subject contains a succinct description of the change:

  • Imperative, present tense (changed/changes ❌ - change ✔️)
  • Don't capitalize first letters
  • No dot (.) needed at the end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment