Skip to content

COMMIT_CONVENTIONS.md

Latest commit

 

History

History
60 lines (34 loc) · 2.54 KB

COMMIT_CONVENTIONS.md

File metadata and controls

60 lines (34 loc) · 2.54 KB
Raw

logo

The Thrust Toolchains

standard-separator

There is a simple guide of standard conventions to follow in order to delivery a good Github commit for the Thrust Toolchains.

Title

It needs to be detailed. It can be include a lot of technical slang. The base of a well designed Github commit title always will be and needs a specific syntax as:

Title - features

Following the syntax:

feat(...)

Valid locations:

  • toolchains Any location that usually involucrates the precompiled LLVM & Clang infrastructure and the build scripts of the targets (Example: targets/x86_64-pc-windows-libcmt).
  • ci Any location that usually involucrates the Continuous Integration (CI/CD) pipelines located on .github/workflows.
  • scripts Any location that usually involucrates helper scripts (Example: scripts/tag_manager).
  • project Any location that usually involucrates the repository itself: README.md, CITATION.cff, LICENSE.txt, or the conception of a new part of the toolchains repository.

Example:

feat(toolchains) Adding a new precompiled LLVM target for Windows.

Title - fixes

Following the syntax:

fix(...)

Valid locations:

  • toolchains Any location that usually involucrates the precompiled LLVM & Clang infrastructure and the build scripts of the targets (Example: targets/x86_64-pc-windows-libcmt).
  • ci Any location that usually involucrates the Continuous Integration (CI/CD) pipelines located on .github/workflows.
  • scripts Any location that usually involucrates helper scripts (Example: scripts/tag_manager).
  • project Any location that usually involucrates the repository itself: README.md, CITATION.cff, LICENSE.txt, or the conception of a new part of the toolchains repository.

Any consecutive location written to the next one needs to be follow for a COMMA character ,.

Example:

fix(ci) Fixing the musl build on the LLVM Linux workflow.

Title - Combinatory

In order to create a well disigned combinatory title, you need to use the following syntax:

(feat(...), fix(...))

  • It needs to be encapsulated for a pair characters PAREN ().
  • Each next feature or fix needs to be followed for a COMMA character ,.

Description

It needs to be concise, short, but detailed in the same time. It can be include a lot of technical slang.