Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.32 KB

GitHub Copilot: 以下是为当前代码编写的 CONTRIBUTING.md 文件：

Contributing to LEAVEN: Bridging Python and Lean Verification through Interactive Interfaces and Code Editor Integration

Thank you for your interest in contributing to LEAVEN! We welcome contributions from everyone, regardless of their level of experience with Python, Lean, or formal verification.

How to Contribute

To contribute to LEAVEN, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them to your branch.
  5. Push your branch to your forked repository on GitHub.
  6. Open a pull request from your branch to the main branch of the original repository.

Please make sure to write clear commit messages and to follow the coding style and guidelines used in the repository.

Code of Conduct

LEAVEN is committed to providing a welcoming and inclusive environment for all contributors. We expect all contributors to follow our Code of Conduct and to treat each other with respect and kindness.

Reporting Issues

If you encounter any issues while using LEAVEN, please report them on the GitHub issue tracker. When reporting an issue, please provide as much detail as possible, including a description of the problem, steps to reproduce it, and any relevant error messages or screenshots.

Citing LEAVEN

If you use LEAVEN in your research, please cite it using the following BibTeX entry:

@misc{leaven,
  author       = {Huajian Xin},
  title        = {LEAVEN: Bridging Python and Lean Verification through Interactive Interfaces and Code Editor Integration},
  year         = {2023},
  publisher    = {GitHub},
  journal      = {GitHub repository},
  howpublished = {\url{https://github.com/xinhjBrant/leaven}},
}

Code Dependencies

LEAVEN depends on the Lean theorem prover and the Python programming language. Please make sure to use the correct versions of these dependencies when working with LEAVEN. You can manage your code's dependencies using the requirements.txt file.

License

LEAVEN is released under the MIT License. By contributing to LEAVEN, you agree to license your contributions under the terms of this license.