Skip to content

Commit

Permalink
CONTRIBUTING: Update commit details to the new structure
Browse files Browse the repository at this point in the history
For commits use the `<chapter>/<content_type>` prefix.

Signed-off-by: Razvan Deaconescu <[email protected]>
  • Loading branch information
razvand authored and teodutu committed Dec 26, 2023
1 parent 4c2b86f commit a6d47ac
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,7 @@ Signed-off-by: Your Name <[email protected]>
Notice that the details above are the name and email that you configured earlier.

Now the `git commit` command will open your default editor and ask you to write a commit message.
Prefix each commit message title with the chapter it belongs to: `software-stack`, `data`, `compute`, `io`, `app-interact` and the component: `lecture` / `lab`.
An example of a prefix is `compute/lab:`.
Prefix each commit message name with the chapter and content type it belongs to, e.g. `template-chapter/reading`, `template-chapter/slides`, `template-chapter/drills`.
Following the prefix, write a short and expressive title on the first line.
Use commit messages with verbs at imperative mood: "Add README", "Update contents", "Introduce feature".

Expand All @@ -105,7 +104,7 @@ How a good commit message should look like: <https://cbea.ms/git-commit/>
Below is an example of a good commit message:

```text
data/lab: Fix Makefile `CFLAGS` error
template-chapter/drills: Fix Makefile `CFLAGS` error
`CFLAGS` was incorrectly set to optimise the code to the `-O3` level. This
caused the function `vulnerable_func()` to be inlined into the caller
Expand Down

0 comments on commit a6d47ac

Please sign in to comment.