Skip to content

Latest commit

 

History

History
72 lines (39 loc) · 3.4 KB

CONTRIBUTING_ZH.md

File metadata and controls

72 lines (39 loc) · 3.4 KB

向 Open Creator 贡献

感谢您对向 Open Creator 贡献的兴趣!作为一个开源项目,我们珍视您的投入和协作,我们的使命是赋能个人,提供可定制的技能库。

贡献的途径多种多样,包括报告错误、提出功能建议,直接增强代码。我们深感谢您在丰富这个项目上的努力。

路线图

我们目前正在制定一个公共路线图,这将提供我们的优先事项和即将到来的改进的洞见。

目前,我们的主要关注点围绕着解决与各种工具集成相关的问题,并维护创建者的核心逻辑。我们的使命是让编码技能变得容易获得,即使是对那些编码背景有限的人也是如此。

鉴于此,我们的愿望是维护一个简单直接的代码库,而不是一个过于复杂的代码库。我们受到将词语转化为即使对非编码者也能行之有效的技能的愿景的驱动。我们热切欢迎在我们引入新功能时,就保持这种方法进行对话。

报告问题

如果您偶然发现一个错误或构思出一个可能有益的功能,请不要犹豫开启一个新问题。为了获得迅速和高效的响应,请提供:

  • 错误报告: 重现问题的详细步骤,关于您的操作系统的具体信息,Python版本,如果需要的话,相关的屏幕截图和代码/错误片段。
  • 功能请求: 关于如何提高 Open Creator 及其社区的详细描述。

贡献代码

我们非常鼓励通过拉取请求贡献代码。以下是一些确保流程顺畅的准则:

  • 对于重大的代码更改,我们建议您首先在 Discord 上讨论您的想法,以确保与我们项目的理念保持一致。我们的目标是保持代码库对新手来说既可访问又不复杂。

  • 派生存储库并为您的修改分支。

  • 确保您的更改伴随着清晰的代码评论,阐明您的策略。力求遵循代码的现有惯例。

  • 启动一个针对 main 的 PR,链接任何相关的问题。提供有关您的修改的详尽细节。

  • 我们将尽可能快地审查 PR,并与您合作进行整合。请耐心等待,因为审查可能需要很多时间。

  • 经批准后,您的贡献将被合并。非常感谢您提升 Open Creator!

运行您的本地分叉

在分叉和分支之后,按照以下步骤运行您的本地分叉:

  1. 导航到项目目录 /open-creator
  2. 使用 poetry install 安装依赖关系。
  3. 通过 poetry run creator 执行程序。

修改后,使用 poetry run creator 重新运行。

安装新包

对于新的依赖添加,请使用 poetry add package-name

已知问题

如果 poetry install 在某些依赖关系上似乎冻结,尝试:

export PYTHON_KEYRING_BACKEND=keyring.backends.fail.Keyring

然后,重新运行 poetry install。如果问题仍然存在,我们的 Discord 社区 始终可提供帮助。

有问题或疑虑吗?

我们的 Discord 社区 是一个充满活力的空间,可以与其他贡献者建立联系。我们非常乐意在您的首次开源贡献之旅中为您提供帮助!

许可

Open Creator 的所有贡献均受 MIT 许可证的约束。

在我们完善我们的操作时,您的耐心和理解是无价的。感谢您成为我们社区不可或缺的一部分!