From 181407ac3b777d848a8d519069d2c15e29d3f411 Mon Sep 17 00:00:00 2001 From: jstoobysmith <72603918+jstoobysmith@users.noreply.github.com> Date: Thu, 16 May 2024 10:17:31 -0400 Subject: [PATCH] docs: Update Contributing file. --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 794c3a1..401196e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,17 @@ This assumes you have already installed Lean and setup HepLean. To add a result to HepLean: - Create a new branch of HepLean. -- Name the branch something which tells people what sort of things you are adding e.g. "StandardModel-HiggsPotential" -- On pushing to a brach GitHub will run a number of continous integration checks on your code. -- Once you are happy, and your branch has passed the continous integration checks, make a pull-request to the main branch of HepLean. +- Name the branch something which tells people what sort of things you are adding e.g., "StandardModel-HiggsPotential" +- On pushing to a branch GitHub will run a number of continuous integration checks on your code. +- Once you are happy, and your branch has passed the continuous integration checks, make a pull-request to the main branch of HepLean. + +## Naming commits + +It is useful to prefix commits with one of the following. +- `feat:` When you add one or more new lemma, definition, or theorems. +- `refactor:` When you are improving the layout and structure of the code. +- `fix:` When fixing a mistake in a definition or other Lean code. +- `docs:` When adding a comment or updating documentation. +- `style:` When adding e.g., white space, a semicolon etc. But does not change the overall + structure of the code. +- `chore:` Updating e.g., workflows. \ No newline at end of file