LukeParke/firecamp
1
0
Fork 0
mirror of https://github.com/LukeHagar/firecamp.git synced 2025-12-06 04:19:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
firecamp/how-to-write-commit-message.md
Nishchit14 377928fe82 launch(firecamp): first camping/commit on oss land
2022-09-20 14:13:40 +05:30

1019 B
Raw Permalink Blame History

How to write commit message?

The commit message will consist of a pattern like the following

type(component): subject line in text (#issue-number)

where

  • type is required
  • component is optional
  • issue-number is optional

an example of commit message is like

with type
feat(authentication): feature is introduced
with type and issue-number
feat: authentication feature is introduced (#114)
with component
feat:(platform) authentication feature is introduced
with component and issue-number
feat:(platform): authentication feature is introduced (#114)

types

  • chore: Regular code maintenance
  • feat: The new feature you're introducing
  • fix: A bug fix
  • test: Everything related to testing
  • ui: Feature and updates related to UI/UX
  • refactor: Refactoring a specific section of the codebase
  • doc: Everything related to documentation

components

Components are yet to define for Firecamp. TBD