You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by ov...@apache.org on 2019/12/16 03:23:51 UTC

[incubator-echarts.wiki] branch master updated: Updated How to make a pull request to the ECharts project? (markdown)

This is an automated email from the ASF dual-hosted git repository.

ovilia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-echarts.wiki.git


The following commit(s) were added to refs/heads/master by this push:
     new 43fdf33  Updated How to make a pull request to the ECharts project? (markdown)
43fdf33 is described below

commit 43fdf33bcaadd6b1bd1677579103bceb7671585b
Author: Ovilia <zw...@gmail.com>
AuthorDate: Mon Dec 16 11:23:46 2019 +0800

    Updated How to make a pull request to the ECharts project? (markdown)
---
 ...s-project?.md => How-to-make-a-pull-request?.md | 36 ++++++++++++++++------
 1 file changed, 26 insertions(+), 10 deletions(-)

diff --git a/How-to-make-a-pull-request-to-the-ECharts-project?.md b/How-to-make-a-pull-request?.md
similarity index 63%
rename from How-to-make-a-pull-request-to-the-ECharts-project?.md
rename to How-to-make-a-pull-request?.md
index f986b3d..3e250b4 100644
--- a/How-to-make-a-pull-request-to-the-ECharts-project?.md
+++ b/How-to-make-a-pull-request?.md
@@ -5,20 +5,21 @@ If you wish to make a pull request to the ECharts project, please read the follo
 ### First-time Contributors
 
 1. Read the [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
-2. (Optional) If you don't know which issues to fix, read Finding Easy Issues to Fix
-3. Comment in the issue and tell us that you are going to look into the issue
-4. (Optional) If you wish to discuss the issue, read Discussion
-5. Before you start writing code, read Coding Standard
+2. (Optional) If you don't know which issues to fix, read [Finding Easy Issues to Fix](#finding-easy-issues-to-fix)
+3. Leave a comment on the issue and tell us that you are going to look into the issue
+4. (Optional) If you wish to discuss the issue, read [Discussion](#discussion)
+5. Before you start writing code, read [Coding Standard](#coding-standard)
 6. Read How to Debug ECharts
 
 ### Making a Pull Request
 
-1. Making changes
-2. (Optional) Add test cases
-3. Run test locally
-4. Commit your changes
-5. Push to remote and create a pull request
-6. Wait for the code review
+1. Name your branch for each issue
+2. Making changes
+3. (Optional) Add test cases
+4. Run test locally
+5. Commit your changes following [Git Message Standard](#git-message-standard)
+6. Push to remote and create a pull request
+7. Wait for the code review
 
 ## Finding Easy Issues to Fix
 
@@ -34,6 +35,21 @@ If you wish to have a discussion about the issue you are fixing or get some help
 
 Please follow the [coding standard](https://echarts.apache.org/en/coding-standard.html) before you make any changes.
 
+It is recommanded to install [eslint](https://eslint.org) plugin to in your IDE to find the invalid code style.
+Otherwise, we can also use
+```bash
+npm run lint
+```
+to check the the code style.
+
+
+## Name Your Branch
+
+Fork ECharts project into your own project. Checkout a branch from master branch named `fix-xxxx` for each issue, where xxxx is the issue id related. If there's no related issue, you need to create one in most cases to describe what's wrong or what new feature is required.
+
+If you are a committer of the `apache/incubator-echarts` project, which means you have the write access to the project, you still need to push to a new branch (by `git push origin HEAD:refs/heads/fix-xxxx`) and use pull request to push your code. You cannot push code directly to `master` branch, otherwise it will be rejected by GitHub.
+
+
 ## How to Debug ECharts
 
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org