Skip to content

Document commit message format

[type] #XXXX: [cmd_name]: short description:

  • detailed description
  • explaining the important changes made
  • XXXX: ticket number
  • [cmd_name]: optional, to get the context of a change

types

  • code change:
    • runtime:
      • fix: bug fix
      • mod: modification of existing code without significant improvement
      • enh: enhancement: improvement of existing code
      • feat: new feature
    • test: tests writing, change, and modification
    • fmt: Black formatting
    • lint: Linting, pylint
    • type: mypy
  • CI/CD .gitlab-ci.yml:
    • ci: continuous integration
    • cd: continuous delivery
  • doc: documentation, README.md AUTHORS.md ″CHANGELOG.md` change
  • dep: dependency introduction, update, management.

Edited by Moul
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information