Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(doc): contributing guide #145

Closed
Wybxc opened this issue Nov 28, 2024 · 5 comments
Closed

feat(doc): contributing guide #145

Wybxc opened this issue Nov 28, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@Wybxc
Copy link
Collaborator

Wybxc commented Nov 28, 2024

功能描述

补充一份贡献指南,以指导新的开发者加入对项目的贡献。

贡献指南的内容应包括:

  • 如何反馈问题
    • 如何报告一个新问题。
    • 如何提出新功能或改进建议。
  • 代码贡献流程
    • 如何设置开发环境。
    • 如何获取项目的源代码。
    • 如何创建分支、提交更改以及发起拉取请求。
  • 编码规范:
    • 代码风格指南,包括命名约定、注释风格等。
    • 代码格式化工具和代码质量检查工具的使用。
  • 测试指南 (feat (test): unit tests for modules and in ci #130):
    • 如何运行测试。
    • 如何编写和提交新的测试用例。
@Wybxc Wybxc added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Nov 28, 2024
@kowyo
Copy link

kowyo commented Nov 29, 2024

我之前也想提 issue 增加一下编译的指南。

我自己实践的编译步骤是:

  • 创建虚拟环境(venv)
  • python -m pip install .

之后就可以运行了

不知道这个步骤是否规范

@Wybxc
Copy link
Collaborator Author

Wybxc commented Nov 30, 2024

我自己实践的编译步骤是:

  • 创建虚拟环境(venv)
  • python -m pip install .

可以用 pip install -e .,这样安装的是开发版本的符号链接,方便即时开发修改

@hellofinch
Copy link
Contributor

提交代码之前使用black对修改的内容进行格式化,方便通过action的check。

@reycn
Copy link
Collaborator

reycn commented Dec 18, 2024

Draft: Contribution Guide 贡献指南
Please drop your suggestions here, if any

@Byaidu Byaidu closed this as completed Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants