Skip to content

Latest commit

 

History

History
139 lines (97 loc) · 5.77 KB

CONTRIBUTING.md

File metadata and controls

139 lines (97 loc) · 5.77 KB

为 YinTao Core 做贡献

目录

YinTao社区

YinTaoCore 由京东集团-京东零售-商业提升事业部-广告架构部-技术效能部下开发团队维护。YinTaoCore 是一个开源项目,没有团队的积极支持是不可能的。我们感谢并鼓励您的贡献。

Coding 活动帮助 YinTaoCore 团队衡量我们的用户最想要什么。

[提交问题] ,分享您对 YinTaoCore 未来的想法。为现有问题添加投票和评论,以帮助我们确定工作的优先级。也可以加入和我们一起讨论。

从源代码构建YinTao Core

如果你想测试 YinTaoCore 的开发版本,或者为项目贡献代码,你需要知道如何从 源代码 构建框架。

准备工作

YinTaoCore 是一个 Node.js 应用程序.我们建议使用最新的稳定版本。 它支持 所有积极维护Node.js 框架版本。 安装过程需要node package manager (npm) 软件实用程序。

运行以下 shell 命令以检查您的操作系统是否包含 nodenpm

node -v; yarn -v

# 安装yarn
npm i -g  yarn

如果您的系统不包含 Node.js, 请从Node.js 官网 下载并安装它。

您还需要在计算机上安装Git 。安装说明取决于您的操作系统——有关详细信息,请参阅Git 网站

创建 YinTao Core

  1. Clone YinTao Core 仓库.

    git clone https://coding.jd.com/YinTao/YinTao-core.git
  2. 切换到仓库的根目录。安装依赖项,请运行以下 shell 命令:

    npm i # 安装依赖
    # 编译代码
    npm run build
    # 安装浏览器环境
    npm run install
  3. 运行以下 shell 命令来构建项目:

    npm run build    # 打包windows, mac
    
    npm run build:linux  #  打包linux( 请异步至虚拟机或linux服务器编译 )

测试新版本

在我们在发布新版本的 YinTaoCore 之前,我们会彻底测试它们。我们邀请您参与此过程。

请不要在生产环境中使用 YinTaoCore 的开发版本。

报告错误和问题

如果您遇到错误,请检查Issues 以获取现有错误报告。如果不存在该问题的报告,请提交一个新问题。

创建一个简单示例

在您的错误报告中包含一个简单示例很重要。一个好的示例可确保问题易于重现和排除故障,同时尽可能小且尽可能简单。

一个最小的工作示例应该:

  • 简单易懂。复杂的场景很难重现。
  • 排除无助于重现问题的代码。删除不影响结果的操作。
  • 包括一整套相关数据:测试页面的 URL、启动选项列表以及启动测试所遵循的步骤。

寻求社区支持

如果您需要有关 YinTaoCore 的帮助,或者想帮助其他用户

贡献代码

提交代码时,请按照以下步骤操作。

  1. 搜索问题列表以查看您要处理的错误或功能是否存在或创建新问题。

  2. 要解决已经描述的问题,请检查计划与您讨论以确保解决。目前没有人在处理它发表的有关您希望解决此问题的说明,并包含有关您如何执行此操作的详细信息。核心团队成员可能需要与您讨论建议开始修复的细节。在他们批准后,发表评论说您已处理此问题。

  3. 在您的开发机器上安装 Node.js

  4. Fork YinTaoCore 并在你的 fork 中创建一个分支。使用问题编号命名此分支,例如, gh852, gh853.

  5. 在本地副本的根目录中,运行: run:

    npm install

    or (for Yarn users):

    yarn
  6. 编写代码并提交您的修改到分支。

  7. 如果您要代码修复错误,请在测试中添加适当的部分。要查找这些部分,请在测试 Regression中搜索。 对于新功能,添加单元/功能测试。

  8. 获取上游更改,并将分支重新设置到 master

  9. 运行测试以检查一切是否正常。

    yarn test
  10. 将改动推送到你的 fork 上,并打开 pull 请求。

在提交拉取请求之前,它必须满足以下条件:

  • 拉取请求名称应描述您实施的更改
  • 拉取请求描述应包含适当的问题编号的关闭指令
  • 所有现有的和新的测试都必须通过
  • 必须在没有错误的情况下进行 linted 代码(请参见制造说明)

指南

YinTaoCore 团队遵循一套写作指南,使我们的文档易于阅读。提交书面内容时请遵守以下规则:

  • 避免双重否定。
  • 避免误导或模棱两可的词语和行话。
  • 避免在代词及其先行词之间进行模糊和混乱的引用。
  • 是描述性的而不是规定性的。
  • 让你的句子简短而简单。确保每个句子只表达一个想法。
  • 不要重复相同的信息。
  • 如果可能,包括交互式示例(代码示例、屏幕截图等)。