Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 2.43 KB

为 imgZoom 做出贡献

感谢您考虑为这个项目做出贡献!无论您是想报告错误、请求功能还是提交拉取请求,我们都非常感谢您的参与。

En

贡献的方式

  • 报告错误: 如果您遇到任何问题或意外行为,请打开一个GitHub问题,其中包含有关该问题的详细信息,包括复制步骤。

  • 请求功能: 请随时提交GitHub问题,以建议您想要看到的新功能或改进。

  • 提交拉取请求: 我们欢迎对bug修复、增强或新功能的拉取请求。提交提取请求时,请确保遵循以下指南。

项目的结构介绍

|—— lib/  //静态资源
|—— log/  //更新日志
|—— src/
  |—— IMG/            //图片
  |—— imgZoom.js      //主要js
  |—— imgZoom.min.js  //压缩js
  |—— index.html      //主页面
  |—— index.js        //入口js
|—— CONTRIBUTING.md
|—— CONTRIBUTING_en.md
|—— deploy.sh         //部署sh
|—— package.json
|—— README.md    
|—— README_en.md
|—— webpack.config.js

如果想要对imgZoom的功能做出代码贡献,可以修改 Next 分支上 src/imgZoom.js ,如果想要测试,可以通过 master 上修改 imgZoom.js 同时运行 npm run serve 进行功能性测试,或者自建项目测试。

项目的分支介绍

master : 项目的主分支,用于介绍项目及测试

Next : 下一个版本的代码

gh-pages :项目的 gh-pages

package :imgzoom-li 的当前版本

拉取请求指南

  1. Fork 存储库: Fork 存储库:如果您还没有,请将存储库 Fork 到您的 GitHub 帐户,并为您的功能或修复创建一个新分支。

  2. 提交指南: 确保您的提交是描述性的,并遵循项目的约定。

  3. 代码样式: 与项目的其他部分保持一致的代码样式。如果适用,请遵守项目中规定的编码标准。

  4. 测试代码: 如果您的贡献涉及代码更改,请确保添加测试并确保现有测试通过。

  5. 提交拉取请求 提交拉取请求:一旦一切就绪,就向存储库的 Next 分支提交一个拉取请求。

问题和支持

如果您有任何问题或需要帮助,请随时联系lixianbin1

感谢您的贡献!


您可以自由定制内容,以更好地满足项目的特定指导原则和要求。如果您需要进一步的帮助或调整,请告诉我!