Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 1005 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1005 Bytes

Contribution

  1. Follow the commit convention.
  2. Run import all.

Commit convention

Follow usual conventional commit for PR title (we always squash merge).

<type>(scope): <subject>

Choose <type> from below (should be one, but like fix/doc might be ok).

  • add: Adding new results, definition, theorems.
  • fix: Fixing existing results for something misformalized
  • refactor: Rename and organize definitions/theorems. (essentially nothing changed about existing facts.)
  • doc: Adding or updating documents.
  • ci: Configure GitHub Actions.
  • chore: Maintaining other things (ex: version-up).

scope is optional, specify like FirstOrder, Modal/Kripke if needed.

Usual commands

Build

lake build Foundation

Import all

lake exe mk_all --module

References

Format references.bib when adding references.

bibtool -r .bibtoolrsc -i references.bib -o references.bib