You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@weex.apache.org by GitBox <gi...@apache.org> on 2018/12/25 02:19:24 UTC
[GitHub] zshshr closed pull request #265: [doc] update development-process
document
zshshr closed pull request #265: [doc] update development-process document
URL: https://github.com/apache/incubator-weex-site/pull/265
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/guide/contribute/development-process.md b/docs/guide/contribute/development-process.md
index 8ef61d0b4..f0e503990 100644
--- a/docs/guide/contribute/development-process.md
+++ b/docs/guide/contribute/development-process.md
@@ -9,13 +9,13 @@ version: 2.1
Contributions are always welcome, but it is very important to understand the development process to make contributing simpler. This document will help you understand how to contribute changes to the Weex source code. Below are the recommended steps.
-## 1. Choose or Create a JIRA issue
+## 1. Choose or Create a Github issue
-Weex uses [JIRA](https://issues.apache.org/jira/projects/WEEX) to track all types of code changes and not just bug fixes. A JIRA ticket should be used to describe *what* should be fixed or modified and the high-level approach of *how* it will be fixed. We use Github pull requests to manage the review and merge specific code changes. Pull Requests describe *how* to implement that change in the project’s source code.
+Weex uses [Github Issues](https://github.com/apache/incubator-weex/issues) to track all types of code changes and not just bug fixes. A Github issue should be used to describe *what* should be fixed or modified and the high-level approach of *how* it will be fixed. We use Github pull requests to manage the review and merge specific code changes. Pull Requests describe *how* to implement that change in the project’s source code.
-If you would like to create a new issue on JIRA, be sure to search the existing issues and see if someone has already reported the same. It helps in avoiding duplication. If your change may be controversial, you may want to create a discussion in the [weex-dev](mailto:dev@weex.incubator.apache.org) mailing list.
+If you would like to create a new issue on Github, be sure to search the existing issues and see if someone has already reported the same. It helps in avoiding duplication. If your change may be controversial, you may want to create a discussion in the [weex-dev](mailto:dev@weex.incubator.apache.org) mailing list.
-**Every pull request should correspond to an issue in JIRA.**
+**Every pull request should correspond to an issue in Github.**
## 2. Develop Your Changes
@@ -57,7 +57,7 @@ If you would like to create a new issue on JIRA, be sure to search the existing
[Open a pull request](https://help.github.com/articles/using-pull-requests/) against the `master` branch of `apache/incubator-weex`. Make sure following guidelines are considered when creating a pull request.
1. There should be one pull request for one issue.
-2. The PR title should be of the form `[WEEX-xxxx][COMPONENT] Summary` where `xxxx` is the relevant JIRA number and `COMPONENT` is one of the mentioned PR categories (android, iOS, jsfm, web, doc, website, example, test, other). `Summary` can be same as JIRA’s title or can also be a more specific title describing the PR itself.
+2. The PR title should be of the form `[WEEX-xxxx][COMPONENT] Summary` where `xxxx` is the relevant Github issue number and `COMPONENT` is one of the mentioned PR categories (android, iOS, jsfm, web, doc, website, example, test, other). `Summary` can be same as Github issue title or can also be a more specific title describing the PR itself.
3. If the pull request is still a work in progress but needs to be pushed to Github to facilitate review, then add `[WIP]` after the component. This also means that the PR is not ready to be merged.
**It is easier to review small pull requests and those are more likely to get merged. Prefer to split the PR if it includes changes for more than one thing.**
@@ -102,7 +102,7 @@ viewing in terminals.
Bug: 123456
```
-A short subject and a blank line after the subject are crucial. Use the bug number from the JIRA issue.
+A short subject and a blank line after the subject are crucial. Use the bug number from the Github issue.
Some good thoughts on how to write better git commit messages can be found [here](https://chris.beams.io/posts/git-commit/).
diff --git a/docs/zh/guide/contribute/development-process.md b/docs/zh/guide/contribute/development-process.md
index 599fbfa01..c6416923a 100644
--- a/docs/zh/guide/contribute/development-process.md
+++ b/docs/zh/guide/contribute/development-process.md
@@ -2,13 +2,13 @@
本文档描述了如何对 Weex 源代码进行更改和提交，以下是建议的步骤：
-## 1. 选择或创建一个 JIRA issue单
+## 1. 选择或创建一个 Github issue单
-目前 Weex 使用 [JIRA Issue](https://issues.apache.org/jira/projects/WEEX) 来跟踪所有类型的代码更改，而不仅仅是 bug 修复，我们使用 Github Pull Request 来管理代码 review 和合并特定的代码更改。也就是说，JIRA用于描述什么是需要修复或更改的，Pull Request 用于描述这些修复和变更如何实现。
+目前 Weex 使用 [Github Issues](https://github.com/apache/incubator-weex/issues)来跟踪所有类型的代码更改，而不仅仅是 bug 修复，我们使用 Github Pull Request 来管理代码 review 和合并特定的代码更改。也就是说，Github Issues用于描述什么是需要修复或更改的，Pull Request 用于描述这些修复和变更如何实现。
在创建新问题之前一定要先搜索问题，避免重复。如果你的更改可能需要和其他开发者进行讨论，你可以在 [weex-dev](mailto:dev@weex.incubator.apache.org) 邮件列表中创建一个讨论。
-**每个 PR 都应该对应于 JIRA 中的一个 issue。**
+**每个 PR 都应该对应于 Github 中的一个 issue。**
## 2. 编写代码
@@ -50,7 +50,7 @@
[创建一个 pull request](https://help.github.com/articles/using-pull-requests/) 并提交到 `apache/incubator-weex` 的 `master` 分支，确保它符合这些准则:
1. 一个 Pull Request 只解决一个问题
-2. PR标题应该是 `[WEEX-xxxx][模块]标题`，其中 `xxxx` 是相关的 JIRA 问题号，模块是 PR 的类别（android、iOS、jsfm、web、component、doc、website、test、other），标题可以是 JIRA 的标题，也可以是描述 PR 本身的更具体的标题。
+2. PR标题应该是 `[WEEX-xxxx][模块]标题`，其中 `xxxx` 是相关的 Github Issue 问题号，模块是 PR 的类别（android、iOS、jsfm、web、component、doc、website、test、other），标题可以是 Github 上Issue 的标题，也可以是描述 PR 本身的更具体的标题。
3. 如果该 PR 相关的工作还在进行中，还没有准备好被合并，但需要被推到 Github 上以方便查看，可以在模块后添加 `[WIP]` 标示。
## 代码风格指南
@@ -92,7 +92,7 @@ viewing interminals.
Bug: 123456
```
-一个简短的主题紧跟一个空行再接着写 commit 的详细描述，Bug 这里使用的是来自 JIRA 的问题号。
+一个简短的主题紧跟一个空行再接着写 commit 的详细描述，Bug 这里使用的是来自 Github Issue 的问题号。
在[这里](https://chris.beams.io/posts/git-commit/)可以找到一些关于如何编写 commit message 的好方法。
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services