contribute_zh.md

贡献指南

本项目可能还存在很多不完善的内容。 我们期待您在以下方面与我们共建仓库, 如果您完成了上述工作并愿意PR和分享到社区，在通过审核后，我们将在项目首页感谢您的贡献。

DEMO制作

1. 建议更多使用 Jupyter NoteBook 的代码。这样，用户能更简单的运行
2. 如果您是一个完整项目，请你在本文件夹中新建一个文件夹，并在文件夹中放入您的代码，请附带中文README和依赖要求( 具体到库版本)。

LawGLM
└── demo_1
    ├── README.md
    ├── requirements.txt
    └── your_code.py

• 我们希望您使用 Apache 2.0 开源协议，如果是，则不需要在额外书写开源协议。
• 请不要在项目中上传2MB以上的单个文件，这可能导致项目臃肿，请使用外链保存。
• 请注意项目中.gitignore的部分，这可能导致您的部分代码没有正常上传，请联系我们修改。

代码规范

良好的代码风格是一种艺术，我们已经为项目准备好了pyproject.toml配置文件，用于规范代码风格。您可以按照以下规范梳理代码:

1. 安装ruff工具

pip install ruff

接着，运行ruff工具

ruff check tools sat inference

检查代码风格，如果有问题，您可以通过ruff format .命令自动修复。

ruff format tools sat inference

如果您的代码符合规范，应该不会出现任何的错误。

命名规范

• 请使用英文命名，不要使用拼音或者其他语言命名。所有的注释均使用英文。
• 请严格遵循 PEP8 规范，使用下划线分割单词。请勿使用 a,b,c 这样的命名。

提交代码

• 创建一个 PR, 并在PR中增加自己的项目。
• 检查是否已经清理掉无用文件，并 assigee 给项目维护者 @zRzRzRzRzRzRzR / @jiawei243 的其中一位进行审核。
• 根据审核要求进行修改。完成后会由审核者合并PR。

最后，再次感谢你们的贡献！