From 2d0ff7a30e6649110dcc247b898a4b4ad3c4a4fd Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:25:09 +0200 Subject: Add some useful links on good git hygiene (#280) Adds links for writing commit messages and doing atomic commits. --- docs/development/contributing-code-to-northstar.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md index 98cf770..37e881c 100644 --- a/docs/development/contributing-code-to-northstar.md +++ b/docs/development/contributing-code-to-northstar.md @@ -31,6 +31,11 @@ To get the cropped GIFs of a screenrecording: (The linked site has not been vetted, use at own risk) 4. Upload GIF to GitHub pull request description by just pasting it at the appropriate location. +### Useful links + +- [How to write a commit message](https://cbea.ms/git-commit/) +- [Atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/) + ### Avoiding "PR hell" _"PR hell"_ is what contributors refer to when a pull request is stuck as pending without any indication for progress. -- cgit v1.2.3