DibyashanuPati/PhysLean
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update Contributing file.

Browse source
This commit is contained in:
jstoobysmith 2024-05-16 10:17:31 -04:00
parent beae6b4ce8
commit 181407ac3b
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

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