Create CONTRIBUTING.md

This commit is contained in:
Joseph Tooby-Smith 2024-05-14 11:49:03 -04:00 committed by GitHub
parent e0c237c823
commit beae6b4ce8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

12
CONTRIBUTING.md Normal file
View file

@ -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.