在开始贡献之前,请确保您的本地环境已经设置好并满足以下要求:
- node版本14.x以上
- 所需依赖项和库的版本正确安装
- Fork 本仓库的main分支到您的 GitHub 账号。
- 创建一个新的分支,用于您的贡献,分支命名建议使用描述性的名称。
- 在分支上进行您的修改和工作。
- 如果新增内容,需要在src/index.ts文件中导入您新增的内容,并且在__test__目录下编写您新增内容的测试用例
- 提交您的更改。请确保您的提交消息清晰、简洁,并且符合代码提交指南(参考下文)。
- 向原仓库的main分支提交 Pull Request。
- 等待代码审核和反馈。根据需要进行修改和调整。
- 一旦您的贡献通过审核,将被合并到main分支。
- main分支用于稳定的发布版本。
- gh-pages分支用于项目文档的发布。
- 请遵循项目的代码风格指南和命名约定。
- 请遵循项目的注释规范,以便其他人理解和维护您的代码。
- 确保您的更改不会影响现有的功能,并通过相关测试用例。
我们期待所有参与者能够遵循我们的社区行为准则。请确保在所有交流和互动中保持友善、尊重和合作的态度。对于任何形式的不当行为,请及时报告给项目维护者。