Skip to content

Commit

Permalink
Update Contribution Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
shigoel committed Feb 22, 2024
1 parent 242004a commit 41fed24
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
* Ensure your PR follows the [contribution
guidelines](https://github.com/leanprover/LNSym/blob/main/CONTRIBUTING.md).

* Be mindful of the **no nonterminal simp** rule in your proofs.

* Do not introduce any new external dependencies.

* Remember to document and comment your code.

* Note that before a PR to the `main` branch can be merged:
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ document before submitting any pull requests or issues.
**Focused Changes**: Create small, focused PRs that address a single
issue or implement a specific feature.

**Maintainable Proofs**: Write your proofs in a maintainable way, even
if doing so causes them to become more verbose. LNSym follows the
***no nonterminal `simp`*** rule, which says that unless `simp` is
closing the goal, it should always be converted to a `simp only [X, Y,
Z]` call.

**External Dependencies**: Do not introduce any new external
dependencies into LNSym's codebase -- be mindful of what you
import. Exceptions are possible, but only when absolutely necessary.

**Documentation**: Add relevant documentation and comments to your
code.

Expand Down

0 comments on commit 41fed24

Please sign in to comment.