29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# Contributing to Lean
|
|
|
|
Thank you for choosing to contribute to Lean, this document is a intended as a brief guide
|
|
for new contributors to help streamline the process and make it as easy as possible
|
|
for you (the contributors) and us (the maintainers).
|
|
|
|
### Writing Code
|
|
|
|
- [Coding Style](doc/coding_style.md)
|
|
- [Library Style Conventions](doc/lean/library_style.org)
|
|
- [Git Commit Conventions](doc/commit_convention.md)
|
|
- [Automatic Builds](doc/make/travis.md)
|
|
|
|
# Opening Issues
|
|
|
|
- Checked that your issue isn't [already filed](https://github.com/leanprover/lean/issues).
|
|
- Specifically look over:
|
|
* the [wishlist](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AI-wishlist),
|
|
* open [RFCs](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3ARFC),
|
|
* open [feature requests](https://github.com/leanprover/lean/issues?q=is%3Aissue+is%3Aopen+label%3AFeature).
|
|
- Reduce the issue to a self-contained, reproducible test case.
|
|
|
|
# Opening Pull Requests
|
|
|
|
- Ensure your Pull Request meets the coding and commit conventions documented above.
|
|
- Ensure your Pull Request contains tests for the behavior, for both features or
|
|
bug fixes.
|
|
|
|
|