From 213579ea6f667a97ac7c3007317ba0895bacd075 Mon Sep 17 00:00:00 2001 From: njlyon0 Date: Wed, 28 Aug 2024 12:33:24 -0400 Subject: [PATCH] docs: added note about 'conventional commits' to contributing guide --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 668288c..02401c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,4 +45,6 @@ Communicating via email is fine though we also have the `#lter-grad-course` chan ## Style Guide +If you are directly contributing to the website, please try to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) syntax in your commit messages so it is easy for others to identify the purpose and scope of changes made in each commit. + As much as possible, use snake case (i.e., all_lowercase_separated_by_underscores). When in doubt, try to maintain consistency with the naming convention and internal structure of other files in the same directory/repository.