Skip to content

COMMIT_CONVENTIONS.md

Latest commit

 

History

History
66 lines (37 loc) · 2.93 KB

COMMIT_CONVENTIONS.md

File metadata and controls

66 lines (37 loc) · 2.93 KB
Raw

logo

Thrust Programming Language | Roadmap

standard-separator

There is a simple guide of standard conventions to follow in order to deliver a good Github commit for the Thrust Programming Language Roadmap (roadmap).

Title

It needs to be detailed. It can 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:

  • conventional Any location that usually involves the articles in the conventional programming roadmap (conventional/), such as CBindgen, Compile Time Code Execution, C Code Execution and Bootstrapping.
  • quantum Any location that usually involves the articles in the quantum programming roadmap (quantum/), such as Backends and QIR.
  • project-visual Any location that usually involves the visual representation or human guide for the roadmap available on Github (Example: README.md).
  • project Any location that usually involves the repository changes, Github files and Github repository conception (Example: LICENSE.txt, CITATION.cff).

Example:

feat(conventional) Adding documentation about compile time type resolution.

Title - fixes

Following the syntax:

fix(...)

Valid locations:

  • conventional Any location that usually involves the articles in the conventional programming roadmap (conventional/), such as CBindgen, Compile Time Code Execution, C Code Execution and Bootstrapping.
  • quantum Any location that usually involves the articles in the quantum programming roadmap (quantum/), such as Backends and QIR.
  • project-visual Any location that usually involves the visual representation or human guide for the roadmap available on Github (Example: README.md).
  • project Any location that usually involves the repository changes, Github files and Github repository conception (Example: LICENSE.txt, CITATION.cff).

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

Example:

fix(conventional) Fixing several issues on the CBindgen articles.

Title - Combinatory

In order to create a well designed 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 ,.

Backticks

As a common practice in the Thrust organization, the commit title is wrapped in backticks (`). Example:

`fix(conventional)` Updating the CBindgen articles.

Description

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