Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CONTRIBUTING: Update commit details to the new structure #15

Merged
merged 1 commit into from
Dec 26, 2023
Merged

CONTRIBUTING: Update commit details to the new structure #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
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