搜索文档 /

导致离子betway东盟体育app

感谢您对Ionic Framework的关注!betway东盟体育app

奉献礼仪

请参见 贡献者行为准则 查阅有关行为准则的资料。

创建一个问题

  • 如果您对使用框架有疑问,请在 betway东盟体育app离子论坛

  • 您需要清楚地描述再现所遇到问题所需的步骤。尽管我们愿意尽可能地帮助我们的用户,但在没有明确的复制步骤的情况下诊断问题是非常耗时的,而且是不可持续的。

  • 问题列表的 betway东盟体育app Repository是专门用于bug报告和特性请求的。不合格问题将立即关闭。

  • 没有明确复制步骤的问题将不会被筛选。如果问题标有“需要:回复”,并且在14天以上没有收到问题作者的进一步回复,则该问题将被关闭。

  • 如果你认为你已经发现了一个bug,或者有了一个新特性的想法,请先确定它还没有出现 报道 .您可以搜索现有的问题,看看是否有类似的报告。包括已关闭的问题,因为它可能已经用解决方案关闭了。

  • 下一个 创建一个新问题 这就彻底解释了问题所在。在提交问题之前,请先填写问题表格。

创建一个良好的代码复制

什么是代码复制?

代码复制是为了演示特定问题而构建的小型应用程序。代码复制应该包含重新创建问题所需的最小代码量,并且应该集中于单个问题。

你为什么要创造一个复制品?

您所遇到问题的代码复制有助于我们更好地找出问题的原因。这是修复任何错误的重要的第一步!

如果没有可靠的代码复制,我们就不可能解决问题,导致问题被关闭。换句话说,创建问题的代码复制有助于我们帮助您。

如何复制

  • 创建一个新的离子应用程序使betway东盟体育app用我们的初学者模板之一。的 空白 starter应用程序是一个很好的选择。您可以使用以下Ionic CLI命令创建一个应用程序:betway东盟体育app betway东盟体育app离子启动myApp空白
  • 添加重新创建您所遇到的问题所需的最小代码量。不要包含任何不需要重现问题的内容。这包括你已经安装的任何第三方插件。
  • 在GitHub上发布应用程序,并包含到它的链接 创建一个问题
  • 确保包括重现问题的步骤。这些步骤应该清晰易懂。

创建复制的好处

  • 使用最新版本的离子:betway东盟体育app 通过创建一个新的Ionic应用程序,betway东盟体育app您可以确保针对框架的最新版本进行测试。有时候,您所遇到的问题已经在该框架的新版本中得到了解决!
  • 最小表面积: 通过删除为了重现问题而不需要的代码,可以更容易地识别问题的原因。
  • 不需要密码: 创建问题的最小复制版本可以避免发布项目中使用的任何专有代码。
  • 寻求帮助解决问题: 如果我们能够可靠地重现一个问题,那么我们就有很好的机会能够解决它。

创建一个Pull请求

  • 我们感谢您抽出时间来做贡献!在提交pull请求之前,我们请求您 创建一个问题 这解释了bug或特性请求,并让我们知道你计划为它创建一个pull请求。如果一个问题已经存在,请评论这个问题,让我们知道你想提交一个拉它的请求。这有助于我们跟踪pull请求,并确保没有重复的工作。

  • 正在寻找一个需要修复的问题?一定要看看我们的问题 需要帮助 标签

安装程序

  1. 下载安装程序 对于Node.js的LTS版本,这是 安装npm
  2. betway东盟体育app 存储库。
  3. 克隆你的叉子。
  4. 从master中创建一个新的分支。
  5. 导航到你想要修改的包目录(core, angular,等等)。
  6. 运行 npm安装 为这个包安装依赖项。
  7. 按照以下特定软件包的步骤操作。

果心

修改组件

  1. 找到要在其中修改的组件 / /核心/ src /组件
  2. 看一下 模板文档 和其他组件,以了解这些组件的实现。
  3. 对组件进行更改。如果更改过于复杂或不同寻常,请添加注释,以便我们能够理解更改。
  4. 预览您的更改 本地。
  5. 修改的文档 如果需要的话。
  6. 运行线头 并确保没有错误。
  7. 构建项目
  8. 在构建完成后,提交更改。请按照 提交消息格式 每一个承诺。
  9. 提交一个Pull请求 你的变化。

预览更改

  1. 运行 npm开始 从内 果心 目录中。
  2. 浏览器应该在 http://localhost:3333/
  3. 从这里,导航到组件的一个测试,以预览您的更改。
  4. 如果显示您的更改的测试不存在, 添加新的测试或更新现有的测试
  5. 要在RTL模式下进行测试,一旦进入所需组件的测试,添加 ?rtl=真 在url的末尾;例如: http://localhost:3333/src/components/alert/test/basic?rtl=true

皮棉变化

  1. 运行 npm运行线头 要删除打字稿和Sass。
  2. 如果有lint错误,运行 npm lint.fix运行 自动修正任何错误。重复第1步,确保错误已经修复,如果没有修复,则手动修复。
  3. 要仅删除和修复TypeScript错误,请运行 npm运行lint.ts npm运行lint.ts.fix ,分别。
  4. 要仅删除和修复Sass错误,请运行 npm lint.sass运行 npm lint.sass.fix运行 ,分别。

修改文档

  1. 定位 自述文件 组件目录中的文件。
  2. 修改的文档 以上 上面写着 <!——自动生成下面——> 在这个文件中。
  3. 要更新该行以下自动生成的文档,请在以下位置进行相关更改:
    • 使用 :更新组件中组件的使用示例 使用/ 目录
    • 性质 事件 ,或 方法 :更新组件的TypeScript文件( * .tsx
    • CSS自定义属性 :更新组件的主Sass文件( * .scss

修改测试

  1. 的内部定位要修改的测试 试验/ 组件目录中的文件夹。
  2. 如果存在测试,则通过添加示例来修改测试,以重现已修复的问题或添加的特性。
  3. 如果需要一个新的测试,最简单的方法是复制 基本的/ 组件的目录 试验/ 目录,重命名它,然后在 index.html e2e.ts 文件(见 测试截图 有关此文件的更多信息)。
  4. 预览/ 目录在文档中用作演示。仅当测试中存在错误或API有未在测试中更新的更改时才更新此测试。
测试截图
  1. 如果测试在截图中存在,将会有一个名为 e2e.ts 在测试目录中。
  2. 可以通过包含此文件并添加一个或多个屏幕截图来添加屏幕截图测试 测试() 包括呼叫的呼叫 page.compareScreenshot()比较 看见 钢网端到端测试 以及现有的测试 核心/ 例如。
  3. 重要的是: 每一个 测试() 应该只有一个截图( page.compareScreenshot()比较 )调用 它应该在每个测试结束时检查expect。如果存在不匹配,它将使测试失败,这将阻止测试的其余部分运行,即,如果第一个屏幕截图失败,则不会调用剩余的屏幕截图调用 除非 它们在一个单独的测试中,或者所有的期望都在最后被调用。
  4. 要在本地运行屏幕截图,请使用以下命令: npm test.screenshot运行
    • 要运行特定测试的屏幕截图,请传递测试路径或要搜索的字符串。
    • 例如,运行所有 警报 测试: npm test.screenshot运行警报
    • 或者,运行基本的 警报 测试: npm运行测试。屏幕截图src/components/alert/test/basic/e2e.ts

建筑的变化

  1. 完成所有更改并更新文档后,运行 npm运行构建 里面的 果心 目录中。如果有必要,这将把您的更改添加到任何自动生成的文件中。
  2. 检查更改,如果一切正常, 提交 更改。
  3. 在提交之前确保构建已经完成。如果您对文档、属性、方法或其他任何需要更新生成文件的内容进行了更改,则需要提交该文件。
  4. 推送更改后,发布分支并 创建一个pull请求

提交拉取请求

  1. 创建一个新的pull请求 分支作为 基础 .你可能需要点击 比较在叉子 查找您的更改。
  2. 从一个fork创建一个pull请求 GitHub帮助文章获取更多信息。
  3. 请尽您所能填写所提供的拉请求模板,并包括任何相关的问题。

提交消息的指导方针

对于git提交消息的格式,我们有非常精确的规则。这将导致在查看项目历史记录时容易理解的可读消息。我们还使用git提交消息生成 变更日志 .我们的格式与Angular的非常相似 提交消息的指导方针

提交消息格式

我们遵循 常规提交规范 .一个提交消息由 身体 页脚 .标题有一个 类型 范围 主题


             ):
复制 复制

是强制性的 范围 header的值是可选的。

还原

如果提交恢复了以前的提交,那么它应该以 回复: ,后面跟着返回的提交的报头。在正文中应该说: 这将恢复提交 ,其中哈希值是要恢复的提交的SHA值。

类型

如果前缀为 的壮举 修复 性能 ,它将出现在更改日志中。但是,如果有 零钱 ,提交将始终出现在更改日志中。

必须是下列情况之一:

  • 的壮举 :新功能
  • 修复 :错误修复
  • 文档 :仅文档更改
  • 风格 :不影响代码含义的更改(空白、格式、缺少分号等)
  • 重构 :一个代码更改,无法修复错误也不添加一个功能
  • 性能 :改进性能的代码更改
  • 测试 :添加缺失的测试
  • 烦人的事 :对构建过程或辅助工具和库(如文档生成)的更改

范围

范围可以是任何指定提交更改位置的内容。通常它会引用一个组件,但它也可以引用一个实用程序。例如 行动表 按钮 css 菜单 导航 等。如果您对同一个组件进行多次提交,请保持该组件的命名一致。例如,如果您更改导航,而第一次提交是 修复(nav) ,你应该继续使用 导航 更多与导航相关的提交。一般来说,如果修改组件,请使用文件夹的名称。

主题

主题包含了对变化的简洁描述:

  • 使用祈使语气,现在时:"change"不是"changed"也不是"changes"
  • 第一个字母不要大写
  • 不要放置句号 最后
  • 提交消息的整个长度不得超过50个字符
  • 描述提交的作用,而不是它涉及或修复的问题
  • 要简短,但要有描述性 -我们应该通过阅读这个主题来很好地理解这个承诺做了什么

身体

就像在 主题 ,使用祈使语气,现在时:“change”而不是“changed”或“changes”。身体应该包括改变的动机,并与之前的行为进行对比。

页脚应包含有关的任何信息 突发的变化 也是引用这个提交的GitHub问题的地方 关闭

突发的变化 应该以单词开头 突破性变化: 用一个空格或两个换行。然后将提交消息的其余部分用于此操作。

例子

没有出现在生成的更新日志:


             Docs (changelog):更新更新步骤
复制 复制

出现在"Features"标题下,toast子标题下:


             专长(toast):添加“按钮”属性
复制 复制

出现在“错误修复”标题,骨架文本子标题下,具有发出#28的链接:


             修复(骨架文本):当动画关闭#28时使用合适的颜色
复制 复制

出现在“性能改进”标题下,以及“重大更改”下,并附有重大更改说明:


             perf(css):删除所有css实用属性使用CSS类代替。
复制 复制

出现在“中断更改”下,带有中断更改说明:


             改变:移除旧的动画系统,使用新的离子动画。betway东盟体育app
复制 复制

下面的提交和提交 667年ecc1 如果它们在同一版本下,则不要出现在更新日志中。如果没有,回复提交将出现在“revert”标题下。


             回复:feat(skeleton-text): add animated property
复制 复制

许可证

通过将您的代码贡献给ionic-team/ionic GitHubbetway东盟体育app Repository,您就同意在MIT许可下授权您的贡献。

下一个
的行为准则
Baidu