From 3fcc08c1a94b24b5e9688f4cc309fdcb29b22f57 Mon Sep 17 00:00:00 2001 From: Sam Hatoum Date: Sun, 2 Jul 2023 15:56:21 -0700 Subject: [PATCH] feat: initial release --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 504ed27..ef89ab3 100644 --- a/README.md +++ b/README.md @@ -76,4 +76,11 @@ Contributions are always welcome! Feel free to open issues and pull requests. We We have a very high bar for automated testing set at a 100% coverage threshold. If you find we've somehow missed any tests, please open an issue, and we'll get it fixed as soon as possible. +Please make sure you are familiar with: + +* Writing [good commit messages](https://twitter.com/dmokafa/status/1351152452179996682) +* Keeping the [commit history clean and tidy](https://www.eficode.com/blog/keep-your-git-commits-clean) +* [Commitizen](https://commitizen-tools.github.io/commitizen/) +* [Semantic Release](https://semantic-release.gitbook.io/semantic-release/) + 📖 "Code is read much more often than it is written, so plan accordingly." - Anonymous