aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>2024-08-29 16:25:09 +0200
committerGitHub <noreply@github.com>2024-08-29 16:25:09 +0200
commit2d0ff7a30e6649110dcc247b898a4b4ad3c4a4fd (patch)
tree0892ed95d31aae213c5b541670e7c9b2c21bdb7f
parentaf66c6e5964dd076a28fe7897e078fe8707435ed (diff)
downloadNorthstarWiki-2d0ff7a30e6649110dcc247b898a4b4ad3c4a4fd.tar.gz
NorthstarWiki-2d0ff7a30e6649110dcc247b898a4b4ad3c4a4fd.zip
Add some useful links on good git hygiene (#280)
Adds links for writing commit messages and doing atomic commits.
-rw-r--r--docs/development/contributing-code-to-northstar.md5
1 files changed, 5 insertions, 0 deletions
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.