CONTRIBUTING.md

Contributing 贡献

Thanks for helping to make meet plan system great!

感谢您帮助使综合指导课系统变得更好！

We welcome all kinds of contributions:

我们欢迎各种贡献：

• Bug fixes Bug修复
• Documentation improvements 文档改进
• New features 新的功能
• Refactoring & tidying 重构和整理
• Fix some typo 修正错字
• Write more tests 编写更多测试

Getting started 入门

If you have a specific contribution in mind, be sure to check the issues and projects in progress - someone could already be working on something similar and you can help out.

如果您有特定的想法，请务必检查 issues 和进行中的 projects -某人可能已经在从事类似的工作，您可以提供帮助。

Project setup 项目设置

After cloning this repo, first you should install Poetry, then ensure dependencies are installed by running:

克隆此存储库后，首先应安装 Poetry, 然后通过运行以下命令来确保已安装依赖项：

poetry install

Then, you should install pre-commit hook of git, and enable it to this project.

然后，你应该安装 git 的 pre-commit 钩子，然后在本仓库将它启用。

pre-commit install

Development 进行开发

推荐使用 Pycharm 进行开发

基于 Django v3.2 和 Graphene v3

您应在本地新建分支后进行开发工作，不应直接在 master 分支直接提交代码。

Running tests 运行测试

After developing, the full test suite can be evaluated by running:

开发完成后，可以通过运行以下命令进行完整的测试：

如您是新增功能，我们需要您为您新增的模块编写测试

python manage.py test

Opening Pull Requests 新建 PR

Please fork the project and open a pull request against the master branch.

请在项目主页右上角 Fork 本项目，将您本地的修改 push 到自己仓库后，针对本仓库 master 分支新建一个PR。

This will trigger a series of test and lint checks.

这将触发一系列测试和格式检查。

We advise that you format and run lint locally before doing this to save time:

我们建议您在提交代码前在本地进行格式化，以节省时间：

如果你按照上面的流程安装了 pre-commit, 下面的命令会在你提交代码时自动执行

black -l 120 --exclude "/migrations/" apps MeetPlan
flake8 apps MeetPlan manage.py

Documentation 文献资料

The documentation is not available now. You can contribute it!

文档现在不可用。 您可以贡献它！