aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMoritz Poldrack <git@moritz.sh>2023-04-06 23:39:26 +0200
committerRobin Jarry <robin@jarry.cc>2023-04-10 15:00:23 +0200
commit8e66f3c364354959abaea2517bf5c18d2fee92ab (patch)
tree318f6ef7c59fac165d885ea288da480bc3711ae7 /CONTRIBUTING.md
parent87e207727c20151811c0888b391b5071840c3a42 (diff)
downloadaerc-8e66f3c364354959abaea2517bf5c18d2fee92ab.tar.gz
chore: fix typos in contributing guidelines
As many do not know, step-by-step is actually an adjective in its own right. Debugging is also written with three g and not with two. Link: https://www.merriam-webster.com/thesaurus/step-by-step Link: https://www.merriam-webster.com/thesaurus/debugging Signed-off-by: Moritz Poldrack <git@moritz.sh> Acked-by: Bence Ferdinandy <bence@ferdinandy.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8bd543fd..55352e59 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -23,7 +23,7 @@ that you did not break anything.
*Unreleased* section of the
[CHANGELOG.md](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md)
file.
-- run the linter using `make lint` if notmuch is not available on your system
+- Run the linter using `make lint`. If notmuch is not available on your system
you may have to edit `.golangci.toml` and disable the notmuch tag. [Otherwise
you could get hard to trace false
positives](https://github.com/golangci/golangci-lint/issues/3061)
@@ -71,7 +71,7 @@ defaults:
git config sendemail.validate true
ln -sf ../../contrib/sendemail-validate-series .git/hooks/sendemail-validate
-And send the patch to the mailing list ([step by step
+And send the patch to the mailing list ([step-by-step
instructions][git-send-email-tutorial]):
$ git send-email --annotate -1
@@ -256,7 +256,7 @@ Messages can be sent to the log file by using the following functions:
- `log.Warnf()`: Use to report issues that do not affect normal use.
- `log.Infof()`: Use to display important messages that may concern
non-developers.
-- `log.Debugf()`: Use to display non-important messages, or debuging
+- `log.Debugf()`: Use to display non-important messages, or debugging
details.
- `log.Tracef()`: Use to display only low level debugging traces.