Merge pull request #24 from HEPLean/jstoobysmith/AddContributingFile

feat: Add contributing file
HEPLean · May 14, 2024 · 2e8fede · 2e8fede
2 parents e0c237c + beae6b4
commit 2e8fede
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# Contributing 
+
+## Adding results to HepLean
+
+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.