max/lean4-htt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
lean4-htt/CONTRIBUTING.md
Leonardo de Moura 5c101d056a doc: update contribution guidelines
2021-05-13 15:17:11 -07:00

3.7 KiB
Raw Blame History

Contribution Guidelines

Thank you for your interest in contributing to Lean! There are many ways to contribute and we appreciate all of them.

Bug reports

Bug reports as new issues are always welcome. Please check the existing issues first. Reduce the issue to a self-contained, reproducible test case.

If you have the chance, before reporting a bug, please search existing issues, as it's possible that someone else has already reported your error.

If you're not sure if something is a bug or not, feel free to file a bug anyway. You may also want to discuss it with the Lean community using the lean4 Zulip channel.

Simple fixes

Simple fixes for typos and clear bugs are welcome.

Documentation

Tutorial-like examples are very welcome. They are useful for finding rough edges and bugs in Lean 4, for highlighting new features, and for showing how to use Lean. If you want to store your tutorial in the Lean 4 repository to make sure future changes will not break it, we suggest the following workflow:

  • Contact one of the Lean developers in Zulip, and check whether your tutorial is a good match for the Lean 4 repository.
  • Send bug reports and report rough edges. We will work with you until the tutorial looks great.
  • Add plenty of comments and make sure others will be able to follow it.
  • Create a pull request in the Lean 4 repository. After merging, we will link it to the official documentation and make sure it becomes part of our test suite.

Contributions to the reference manual are also welcome, but since Lean 4 is changing rapidly, please contact us first using Zulip to find out which parts are stable enough to document. We will work with you to get this kind of pull request merged. We are also happy to meet using Zoom, Skype or Google hangout to coordinate this kind of effort.

As Lean 4 matures, other forms of documentation (e.g., doc-strings) will be welcome too.

"Help wanted"

For issues marked as help wanted, pull requests (PR) are welcome and we will work with you to get a PR merged. Some of these issues are nontrivial. If you are interested, please consider adding comments to the PR and/or messaging the Lean developers in Zulip.

Unexpected Pull Requests

We have very few core developers, and we cannot review arbitrary pull requests (PR). So, please contact the core developers before investing your time on a nontrivial modification. We suggest the following workflow:

  • Discuss with the Lean community it Zulip whether there is interest.
  • Create an issue on the Lean 4 repository at GitHub, tag it with RFC.
  • Ask the community to help documenting the requirements, collecting examples and concerns.
  • Wait for one of the core developers to give you a "go ahead". At this point, the core developers will work with you to make sure your PR gets merged.

We don't want to waste your time by you implementing a feature and then us not being able to merge it.

How to Contribute

  • Always follow the commit convention.
  • Follow the style of the surrounding code. When in doubt, look at other files using the particular syntax as well.
  • Make sure your code is documented.
  • New features or bug fixes should come with appropriate tests.
  • Ensure all tests work before submitting a PR; see Development Setup and Fixing Tests.