mirror of
https://github.com/VisActor/VChart
synced 2024-11-23 09:39:38 +00:00
docs: update contribution guide
This commit is contained in:
xiaoluoHe
parent
23131bf923
commit
9927900a73
218
CONTRIBUTING.md
218
CONTRIBUTING.md
@ -1,70 +1,206 @@
|
||||
# Contributing
|
||||
First of all, I would like to give you a thumbs up 👍🏻 for choosing to contribute to the open source community. Also, thank you very much for choosing to participate in the VisActor community and contribute to this open source project.
|
||||
|
||||
## Code of Conduct
|
||||
## VChart Contribution Guide
|
||||
|
||||
We has adopted [the Contributor Covenant](CODE_OF_CONDUCT.md) as our Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
|
||||
The VisActor team usually develops and maintains issues on GitHub. Please open the [GitHub website](https://github.com/), click the `Sign up `button in the upper right corner, register your own account, and take the first step in your open source journey.
|
||||
|
||||
## Open Development
|
||||
If you cannot open the Github site due to special circumstances, please inform us and proceed with project development through [Gitee](https://gitee.com/VisActor/VChart).
|
||||
|
||||
All work on VChart happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
|
||||
In the [VChart repository](https://github.com/VisActor/VChart), we have a [guide ](https://github.com/VisActor/VChart/blob/develop/CONTRIBUTING.md)for all open source contributors on versioning, branching, and more. **Please take a few minutes to read about it** .
|
||||
|
||||
## Semantic Versioning
|
||||
## Your first PullRequest
|
||||
|
||||
VChart follows [semantic versioning](https://semver.org/). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
|
||||
### Step 0: Install Git
|
||||
|
||||
Every significant change is documented in the changelog file.
|
||||
Git is a version control system used to track and manage code changes in software development projects. It helps developers record and manage the history of code, facilitating team collaboration, code version control, merging code, and other operations. With Git, you can track each version of each file and easily switch and compare between different versions. Git also provides branch management functionality, allowing for multiple parallel development tasks to be performed simultaneously.
|
||||
|
||||
## Branch Organization
|
||||
- Visit the official Git website: [https://git-scm.com](https://git-scm.com/)
|
||||
- Download the latest version of the Git installer.
|
||||
- Run the downloaded installation program and follow the prompts of the installation wizard to install.
|
||||
- After the installation is complete, you can use the Command Line command `git version `to confirm the installation is successful.
|
||||
|
||||
Submit all changes directly to the develop branch. The main branch represents the latest production version of the project. We do our best to keep the main and develop branch in good shape, with all tests passing.
|
||||
### Step 1: Fork the project
|
||||
|
||||
Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.
|
||||
- First, you need to fork this project, enter the [VChart project page](https://github.com/VisActor/VChart), and click the Fork button in the upper right corner
|
||||
|
||||
## Bugs
|
||||
|
||||
|
||||
We are using [GitHub Issues](https://github.com/VisActor/VChart/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
|
||||
- The project Your_Github_Username/vchart will appear in your GitHub account
|
||||
- Use the following command on your local computer: Get a VChart folder
|
||||
|
||||
We have already prepared issue templates for bug reports and feature requests. If you want to fire an issue, just enter the [New issue](https://github.com/VisActor/VChart/issues/new/choose) page and select either of them to get started. The best way to get your bug fixed is by using our issue template and provide reproduction steps with this [template](https://github.com/VisActor/VChart/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+).
|
||||
```
|
||||
// ssh
|
||||
git clone git@github.com:Your_Github_Username/VChart.git
|
||||
// https
|
||||
git clone https://github.com/Your_Github_Username/VChart.git
|
||||
```
|
||||
|
||||
## Proposing a Change
|
||||
### Step 2: Get the project code
|
||||
|
||||
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue, or just enter the [New issue](https://github.com/VisActor/VChart/issues/new/choose) page and select either of them to get started.
|
||||
- Go to the VChart folder and add the remote address of the VChart
|
||||
|
||||
If you’re only fixing a bug, it’s fine to submit a pull request right away but we still recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue.
|
||||
```
|
||||
git remote add upstream https://github.com/VisActor/VChart.git
|
||||
```
|
||||
|
||||
## Your First Pull Request
|
||||
- Get the latest source code of VChart
|
||||
|
||||
Working on your first Pull Request? You can learn how from this free video series:[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||||
```
|
||||
git pull upstream develop
|
||||
```
|
||||
|
||||
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/VisActor/VChart/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that contain bugs that have a relatively limited scope. This is a great place to get started.
|
||||
### Step 3: Create a branch
|
||||
|
||||
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
|
||||
- Okay, now we can start contributing our code. The default branch of VChart is the develop branch. Whether it's feature development, bug fixing, or documentation writing, please create a new branch and merge it into the develop branch. Use the following code to create a branch:
|
||||
|
||||
If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment.
|
||||
```
|
||||
// Create a feature development branch
|
||||
git checkout -b feat/xxxx
|
||||
|
||||
### Sending a Pull Request
|
||||
// Create a issue-fix development branch
|
||||
git checkout -b fix/xxxx
|
||||
|
||||
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We’ll do our best to provide updates and feedback throughout the process.
|
||||
// Create documentation and demo branches
|
||||
git checkout -b docs/add-funnel-demo
|
||||
```
|
||||
|
||||
**Before submitting a pull request**, please make sure the following is done:
|
||||
Suppose we create a document modification branch `docs/add-fund-demo`
|
||||
|
||||
1. Fork the [repository](git@github.com:VisActor/VChart.git) and create your branch from `develop`.
|
||||
2. (If rush has been install, just go to step 3) global install [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)：`npm i --global @microsoft/rush`.
|
||||
3. Run `rush update` in the repository root.
|
||||
4. If you’ve fixed a bug or added code that should be tested, add tests!
|
||||
5. Ensure the test suite passes (`rush test`).
|
||||
6. If you've modified sources code(The code in `src/` folder), make sure you've run `rush change`, and commit the rush changelog in `common/changes`.
|
||||
7. Run `rush compile` for typescript check. Tip: we will also do this check in github workflow.
|
||||
- Now we can change the code on the branch
|
||||
|
||||
## Development Workflow
|
||||
- Assuming we have added some code and submitted it to the codebase
|
||||
|
||||
After cloning VChart, run `rush update` to fetch its dependencies. Then, you can run several commands:
|
||||
- Git commit -a -m "docs: add custom funnel demo and related docs". The commit information of VisActor follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)specification
|
||||
|
||||
1. `rush start` runs VChart test page locally.
|
||||
2. `rush react` runs React VChart test page locally.
|
||||
3. `rush eslint` checks the code style.
|
||||
4. `rush test` runs the complete test suite.
|
||||
5. `rush run -p <project_name> -s <script>` run the specified script for the specified project, eg. `rush run -p @visactor/vchart -s start`
|
||||
6. `rush prettier --dir <project_relative_path> --ext <file_type>` prettier the specified script for the specified project, eg. `rush prettier --dir packages/vchart --ext ts`
|
||||
- `<type>[optional scope]: <description>`
|
||||
- The commonly used `types `include docs (document, log modification), feat (new feature), fix (problem repair), refactor (Code Refactoring), etc. Please choose according to the actual situation.
|
||||
- Please write a brief and accurate description in English.
|
||||
- Before submitting the commit, we will perform a commit lint check, you can check the [rules](https://github.com/VisActor/VChart/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js)
|
||||
|
||||
If you want to update documents, you can run `rush docs` to preview VChart document contents locally.
|
||||
### Step 4: Merge and modify
|
||||
|
||||
- A common issue is that remote upstream (@visactor/vchart) has new updates, which can cause conflicts when we submit Pull Requests. Therefore, we can merge the commits of other remote developers with ours before submitting. Use the following code to switch to the develop branch.
|
||||
|
||||
```
|
||||
git checkout develop
|
||||
```
|
||||
|
||||
- Use the following code to pull out the latest remote code:
|
||||
|
||||
```
|
||||
git pull upstream develop
|
||||
```
|
||||
|
||||
- Switch back to your own development branch.
|
||||
|
||||
```
|
||||
git checkout docs/add-funnel-demo
|
||||
```
|
||||
|
||||
- Merge the develop commit into your own branch.
|
||||
|
||||
```
|
||||
git rebase develop
|
||||
```
|
||||
|
||||
- Submit the updated code to your own branch.
|
||||
|
||||
```
|
||||
git push origin docs/add-funnel-demo
|
||||
```
|
||||
|
||||
### Step 5: Submit Pull Request
|
||||
|
||||
You can click the `Compare & Pull Request `button on your GitHub repository page.
|
||||
|
||||
|
||||
|
||||
Or create via the `contribute `button:
|
||||
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/create-PR-2.png">
|
||||
</div>
|
||||
|
||||
Fill in the submitted modification content according to the template.
|
||||
|
||||
- Check what type of modification this is
|
||||
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/issue-checklist.png">
|
||||
</div>
|
||||
|
||||
- Fill in the associated issue
|
||||
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/related-issue.png">
|
||||
</div>
|
||||
|
||||
- If there are complex changes, please explain the background and solution
|
||||
|
||||
<div align='center'>
|
||||
<img style="height:120px" src="/vchart/guide/contribution-guide/issue-background.png">
|
||||
</div>
|
||||
|
||||
After filling in the relevant information, click Create pull request to submit.
|
||||
|
||||
## Getting Started with VChart Contribution
|
||||
|
||||
" **Good first issue** " is a common hashtag in the open source community, and the purpose of this hashtag is to help new contributors find problems that are suitable for beginners.
|
||||
|
||||
VChart beginner questions, you can view through the [issues list](https://github.com/VisActor/VChart/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), currently includes two categories:
|
||||
|
||||
- Demo case production
|
||||
- Simple feature development
|
||||
|
||||
If you currently **have time and willingness** to participate in community contributions, you can take a look at the **good first issue** in the issue and choose a claim that is interested and suitable for yourself.
|
||||
|
||||
I believe you must be a colleague who has a beginning and an end. Therefore, when you understand and decide to claim an issue, please leave a message under the issue to inform everyone.
|
||||
|
||||
### Demo Task Development Guide
|
||||
|
||||
We have prepared some common cases in practical application scenarios and need to consider how to utilize the capabilities of VChart to achieve them.
|
||||
|
||||
You can get started with using VChart through this type of task. VChart provides rich capabilities, and everyone may have different implementation ideas. **You can leave a message under the issue and discuss your own plan with everyone** .
|
||||
|
||||
After completing the task, you can submit the self-made case to the official website demo for more people in need to learn and use.
|
||||
|
||||
All demos are stored in the `docs/assets/examples `directory
|
||||
|
||||
1. Please create a new `docs/*** `or `demo/*** `branch based on the develop branch for development
|
||||
2. (If you have already installed, skip this step) Global installation [@microsoft/rush](https://rushjs.io/pages/intro/get_started/): `npm i --global @microsoft/rush`
|
||||
3. Run `rush update`
|
||||
4. Run `rush docs `to preview the current demo content locally
|
||||
5. `Docs `directory
|
||||
1. `Docs/assets/examples/menu.json `Add your demo information to the directory file
|
||||
2. Complete the Chinese and English demo documents in the `zh `/ `en `directory respectively
|
||||
3. Add the demo preview image in the `docs/public/vchart/preview `directory and update the relative path in the demo document
|
||||
6. Submit all code and create a Pull Request on Github, inviting others to review
|
||||
|
||||
### Feature Task Development Guide
|
||||
|
||||
We have prepared some simple and easy-to-use feature development tasks. If you have a certain foundation in JavaScript/TypeScript, you can claim these tasks.
|
||||
|
||||
You can understand the VChart code architecture faster through requirement development. **You can leave a message under the issue and discuss your own plan with everyone** .
|
||||
|
||||
1. Please create a new `feat/*** `branch based on the develop branch for development
|
||||
2. (If you have already installed, skip this step) Global installation [@microsoft/rush](https://rushjs.io/pages/intro/get_started/): `npm i --global @microsoft/rush`
|
||||
3. Run `rush update`
|
||||
4. Run `rush start ` to start demo page:
|
||||
1. You can create a index.page page under `develop/packages/vchart/__tests__/runtime/browser `to import your own created development use cases
|
||||
5. Confirm that all tests pass the `rush test`
|
||||
6. After development is finished, run `rush change `command, write changelog and submit
|
||||
7. Submit all code and create a Pull Request on Github, inviting others to review
|
||||
|
||||
## Embrace the VisActor community
|
||||
|
||||
In addition to contributing code to VisActor, we encourage you to participate in other things that make the community more prosperous, such as:
|
||||
|
||||
1. Provide suggestions for project development, functional planning, etc
|
||||
2. Create articles, videos, and hold lectures to promote VisActor.
|
||||
3. Write promotion plan and execute it together with the team
|
||||
|
||||
VisActor is also working hard to help colleagues who participate in community building grow together. We plan (but are not limited to, looking forward to more suggestions from everyone) to provide the following assistance:
|
||||
|
||||
1. Data lake visualization development training based on VisActor helps participating colleagues grow rapidly in programming skills, visualization theory, architecture design and other aspects.
|
||||
2. Regularly select "Code Contribution Award" and "Community Promotion Award".
|
||||
3. Organize community members to participate in open source activities
|
||||
|
||||
@ -1,73 +1,203 @@
|
||||
# 贡献指南
|
||||
首先为你选择加入开源贡献行列的行为点赞 👍🏻。再者，十分感谢你选择参与到 VisActor 社区，为这个开源项目做出贡献。
|
||||
|
||||
首先非常感谢你能抽出时间为我们的开源项目做贡献。希望这份指南能够清晰地阐明贡献过程并回答你可能有的一些问题，所以请你在提 issue 或者 pull request 之前花几分钟时间阅读。
|
||||
## VChart 贡献指南
|
||||
|
||||
## 行为准则
|
||||
VisActor 团队通常在 github 上进行开发和 issue 维护，请打开 [Github 网站](https://github.com/)，点击右上角 `Sign up` 按钮，注册一个自己的账号，开启你开源之旅的第一步。
|
||||
|
||||
我们有一份[行为准则](CODE_OF_CONDUCT.md)，希望所有的贡献者都能遵守，请花时间阅读一遍全文以确保你能明白哪些是可以做的，哪些是不可以做的。
|
||||
如果因为特殊情况，你无法打开 Github 站点，请告知我们并通过 [Gitee](https://gitee.com/VisActor/VChart) 进行项目开发。
|
||||
|
||||
## 透明的开发
|
||||
|
||||
我们所有的工作都会放在 [GitHub](https://github.com/VisActor/) 上。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review。
|
||||
|
||||
## 版本管理
|
||||
|
||||
VChart 遵循[语义化版本控制](https://semver.org/lang/zh-CN/)。我们发布 patch 补丁版本以修复重要的错误，发布 minor 次要版本以提供新功能或非必要的更改，发布 major 主要版本以适应任何重大更改。当我们进行重大更改时，在次要版本中还会引入弃用警告，以便用户了解即将到来的更改并提前迁移代码。
|
||||
|
||||
每个重要的更改我们都会记录在对应项目 CHANGELOG 更新日志中。
|
||||
|
||||
## 分支管理
|
||||
|
||||
**请将所有的更改提交到 `develop` 主分支**。`main` 代表了项目的最新的生产版本。我们尽力保持主分支和开发分支保持良好状态，确保所有测试都能通过。
|
||||
|
||||
这里需要注意，所有进入主分支的代码必须与最新的稳定版本兼容，它可能包含其他功能，但不能有任何破坏性更改。我们应该能够随时从主分支的末端发布一个新的次要版本。
|
||||
|
||||
## Bugs 管理
|
||||
|
||||
我们使用 [GitHub Issues](https://github.com/VisActor/VChart/issues) 来追踪所有的缺陷。无论内外部的缺陷，我们都会在 issues 上进行管理，尽量让一切公开、清晰明了。在你报告一个 bug 之前，请先确保已经搜索
|
||||
过已有的 issues。
|
||||
|
||||
如果你想要你发现的 bug 被快速解决，最好的办法就是根据我们提供的 issue 模板进行提问，只需要进入 [New issue](https://github.com/VisActor/VChart/issues/new/choose) 页面，然后选择其中任意一个开始即可，最好能使用这个[模板](https://github.com/VisActor/VChart/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+) 来提供复现的示例代码。
|
||||
|
||||
## 提交变更建议
|
||||
|
||||
如果你有改进我们的配置项、接口或者新增功能的想法，我们同样推荐你通过 issue 进行提问，或者进入我们的 [New issue](https://github.com/VisActor/VChart/issues/new/choose) 页面，选择相应的 issue 模板进行提交，
|
||||
|
||||
如果你准备帮助我们修复一个 bug，那么你可以立即提交一个 pull request 请求，但我们仍然建议你先创建一个 issue 并在 issue 中详细说明将要修复的内容，这样可以帮助我们更好得追踪问题。
|
||||
在 [VChart 仓库](https://github.com/VisActor/VChart)中，我们有一份面向所有开源贡献者的[指南](https://github.com/VisActor/VChart/blob/develop/CONTRIBUTING.zh-CN.md)，介绍了有关版本管理、分支管理等内容，**请花几分钟时间阅读了解一下**。
|
||||
|
||||
## 你的第一个 Pull Request
|
||||
|
||||
如果你还不清楚怎么在 GitHub 上提 Pull Request ，可以阅读下面这篇文章来学习：[如何优雅地在 GitHub 上贡献代码](https://segmentfault.com/a/1190000000736629)
|
||||
### Step0：安装 Git
|
||||
|
||||
为了能帮助你开始你的第一次尝试，我们用[good first issues](https://github.com/VisActor/VChart/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)标记了一些比较容易修复的 bug 和小功能。这些 issue 可以很好地作为你的首次尝试。
|
||||
Git 是一种版本控制系统，用于跟踪和管理软件开发项目中的代码变更。它帮助开发者记录和管理代码的历史记录，方便团队协作、代码版本控制、合并代码等操作。通过 Git，您可以追踪每个文件的每个版本，并轻松地在不同版本之间进行切换和比较。Git 还提供了分支管理功能，使得可以同时进行多个并行开发任务。
|
||||
|
||||
如果你打算开始处理一个 issue，请先检查一下 issue 下面的留言以确保没有别人正在处理这个 issue。如果当前没有人在处理的话你可以留言告知其他人你将会处理这个 issue，以免别人重复劳动。
|
||||
- 访问 Git 官方网站：<https://git-scm.com/>
|
||||
- 下载最新版本的 Git 安装程序。
|
||||
- 运行下载的安装程序，按照安装向导的提示进行安装。
|
||||
- 安装完成后，你可以通过命令行使用 `git version` 命令确认安装成功。
|
||||
|
||||
如果之前有人留言说会处理这个 issue 但是一两个星期都没有动静，那么你也可以接手处理这个 issue，当然还是需要留言告知其他人。
|
||||
### Step1：Fork 项目
|
||||
|
||||
### 如何发送 Pull Request
|
||||
- 首先需要 fork 这个项目，进入[VChart 项目页面](https://github.com/VisActor/VChart)，点击右上角的 Fork 按钮
|
||||
|
||||
VisActor 团队会关注所有的 pull request，我们会 review 以及合并你的代码，也有可能要求你做一些修改或者告诉你我们为什么不能接受这样的修改。我们将尽最大努力在整个过程中提供及时的更新和反馈。
|
||||
|
||||
|
||||
在**你发送 Pull Request 之前**，请确认你是按照下面的步骤来做的：
|
||||
- 你的 github 帐号中会出现 xxxx(你的 github 用户名)/vchart 这个项目
|
||||
- 在本地电脑上使用以下命令: 得到一个 VChart 文件夹
|
||||
|
||||
1. 基于 `develop` 分支做修改
|
||||
```
|
||||
// ssh
|
||||
git clone git@github.com:xxxx(你的github用户名)/VChart.git
|
||||
// https
|
||||
git clone https://github.com/xxxx(你的github用户名)/VChart.git
|
||||
```
|
||||
|
||||
### Step2：获取项目代码
|
||||
|
||||
- 进入 VChart 文件夹，添加 VChart 的远程地址
|
||||
|
||||
```
|
||||
git remote add upstream https://github.com/VisActor/VChart.git
|
||||
```
|
||||
|
||||
- 获取 VChart 最新源码
|
||||
|
||||
```
|
||||
git pull upstream develop
|
||||
```
|
||||
|
||||
### Step3：创建分支
|
||||
|
||||
- 好了，现在可以开始贡献我们的代码了。VChart 默认分支为 develop 分支。无论是功能开发、bug 修复、文档编写，都请新建立一个分支，再合并到 develop 分支上。使用以下代码创建分支：
|
||||
|
||||
```
|
||||
// 创建功能开发分支
|
||||
git checkout -b feat/xxxx
|
||||
|
||||
// 创建问题修复开发分支
|
||||
git checkout -b fix/xxxx
|
||||
|
||||
// 创建文档、demo分支
|
||||
git checkout -b docs/add-funnel-demo
|
||||
```
|
||||
|
||||
假设我们创建了文档修改分支 `docs/add-funnel-demo`
|
||||
|
||||
- 现在我们可以在分支上更改代码了
|
||||
- 假设我们已经添加了一些代码，提交到代码库
|
||||
- git commit -a -m "docs: add custom funnel demo and related docs" 。VisActor 的 commit 提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 规范
|
||||
|
||||
- `<type>[optional scope]: <description>`
|
||||
- 其中常用的`type`包括 docs（文档、日志修改）、feat（新功能）、fix（问题修复）、refactor（代码重构）等，请根据实际情况选择。
|
||||
- 请用简短精确的英文描述编写 description
|
||||
- 提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VChart/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js)
|
||||
|
||||
### Step4：合并修改
|
||||
|
||||
- 一个常见的问题是远程的 upstream (@visactor/vchart) 有了新的更新， 从而会导致我们提交的 Pull Request 时会导致冲突。 因此我们可以在提交前先把远程其他开发者的 commit 和我们的 commit 合并。使用以下代码切换到 develop 分支:
|
||||
|
||||
```
|
||||
git checkout develop
|
||||
```
|
||||
|
||||
- 使用以下代码拉出远程的最新代码:
|
||||
|
||||
```
|
||||
git pull upstream develop
|
||||
```
|
||||
|
||||
- 切换回自己的开发分支:
|
||||
|
||||
```
|
||||
git checkout docs/add-funnel-demo
|
||||
```
|
||||
|
||||
- 把 develop 的 commit 合并到自己分支：
|
||||
|
||||
```
|
||||
git rebase develop
|
||||
```
|
||||
|
||||
- 把更新代码提交到自己的分支中:
|
||||
|
||||
```
|
||||
git push origin docs/add-funnel-demo
|
||||
```
|
||||
|
||||
### Step5：提交 Pull Request
|
||||
|
||||
你可以在你的 github 代码仓库页面点击 `Compare & pull request` 按钮。
|
||||
|
||||
|
||||
|
||||
或通过 `contribute` 按钮创建：
|
||||
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/create-PR-2.png">
|
||||
</div>
|
||||
|
||||
按照模板填写本次提交的修改内容：
|
||||
|
||||
- 勾选这是什么类型的修改
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/issue-checklist.png">
|
||||
</div>
|
||||
|
||||
- 填写关联的 issue
|
||||
|
||||
<div align='center'>
|
||||
<img style="width:200px" src="/vchart/guide/contribution-guide/related-issue.png">
|
||||
</div>
|
||||
|
||||
- 若有复杂变更，请说明背景和解决方案
|
||||
|
||||
<div align='center'>
|
||||
<img style="height:120px" src="/vchart/guide/contribution-guide/issue-background.png">
|
||||
</div>
|
||||
|
||||
相关信息填写完成后，点击 Create pull request 提交。
|
||||
|
||||
## **轻松步入 VChart 开源贡献之旅**
|
||||
|
||||
"**good first issue**" 是一个在开源社区常见的标签，这个标签的目的是帮助新贡献者找到适合入门的问题。
|
||||
|
||||
VChart 的入门问题，你可以通过 [issue 列表](https://github.com/VisActor/VChart/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 查看，目前包括两类：
|
||||
|
||||
- Demo 案例制作
|
||||
- 简单功能开发
|
||||
|
||||
如果你当前**有时间和意愿**参与到社区贡献，可以在 issue 里看一看 **good first issue**，选择一个感兴趣、适合自己的认领。
|
||||
|
||||
相信你一定是一个有始有终的同学，所以，当你了解并决定认领一个 issue 后，请在 issue 下留言告知大家。
|
||||
|
||||
### Demo Task 开发指南
|
||||
|
||||
我们准备了一些在实际应用场景中常见的案例，需要思考如何利用 VChart 的能力实现。
|
||||
|
||||
你可以通过这类任务，上手对 VChart 的使用。VChart 提供了丰富的能力，每个人或许都有不同的实现思路，**你可以在 issue 下留言，和大家讨论自己的方案**。
|
||||
|
||||
任务完成后，你可以将自己制作的案例提交到官网 demo，让更多需要的人学习和使用。
|
||||
|
||||
所有的 demo 存放在 `docs/assets/examples` 目录下
|
||||
|
||||
1. 请基于 develop 分支，新拉一个 `docs/***`或 `demo/***` 分支进行开发
|
||||
2. （如果你已经安装，请跳过此步骤）全局安装 [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)：`npm i --global @microsoft/rush`
|
||||
3. 根目录下运行 `rush update`
|
||||
4. 如果你修复了一个 bug 或者新增了一个功能，请确保写了相应的测试，这很重要。
|
||||
5. 确认所有的测试都是通过的 `rush test`。
|
||||
6. 如果你的修改涉及源码，确保在每次提交的时候运行 `rush change`，并且将 rush changelog 也提交上，rush changelog 保存在 `common/changes` 文件夹下。
|
||||
7. 运行 `rush compile` 进行 ts 类型检测。小贴士：我们在 GitHub CI 流程中也会该项检查。
|
||||
4. 运行`rush docs` 在本地预览目前 demo 内容
|
||||
5. `docs` 目录下:
|
||||
1. `docs/assets/examples/menu.json` 目录文件中添加你的 demo 信息
|
||||
2. 在`zh`/`en`目录下分别完成中英文 demo 文档
|
||||
3. 在 `docs/public/vchart/preview`目录下添加 demo 预览图片并将相对路径更新在 demo 文档中
|
||||
6. 提交所有代码，并在 Github 创建 Pull Request，邀请其他人进行 review
|
||||
|
||||
## 开发流程
|
||||
### Feature Task 开发指南
|
||||
|
||||
在你 clone 了 VChart 的代码并且使用 `rush update` 安装完依赖后，你还可以运行下面几个常用的命令：
|
||||
我们准备了一些简单、易上手的特性开发任务，如果你有一定的 Javascript / Typescript 基础，可以认领这类任务。
|
||||
|
||||
1. `rush start` 在本地运行 VChart 代码的测试页面
|
||||
2. `rush react` 在本地运行 React-VChart 代码的测试页面
|
||||
3. `rush eslint` 运行所有项目的 eslint 脚本
|
||||
4. `rush test` 运行所有项目的 test 脚本
|
||||
5. `rush run -p <project_name> -s <script>` 运行指定项目的指定脚本，eg. `rush run -p @visactor/vchart -s start`
|
||||
6. `rush prettier --dir <project_relative_path> --ext <file_type>` 格式化指定项目的源代码，eg. `rush prettier --dir packages/vchart --ext ts`
|
||||
你可以通过需求开发，更快地了解 VChart 代码架构。**你可以在 issue 下留言，和大家讨论自己的方案**。
|
||||
|
||||
如果你需要更新文档内容，你可以执行 `rush docs` 在本地运行 VChart 的文档内容预览。
|
||||
1. 请基于 develop 分支，新拉一个 `feat/***`分支进行开发
|
||||
2. （如果你已经安装，请跳过此步骤）全局安装 [@microsoft/rush](https://rushjs.io/pages/intro/get_started/)：`npm i --global @microsoft/rush`
|
||||
3. 根目录下运行 `rush update`
|
||||
4. `rush start` 在本地运行 VChart 代码的测试页面
|
||||
- 你可以在`develop/packages/vchart/__tests__/runtime/browser`下创建 index.page.local 页面，引入自己创建的开发用例
|
||||
5. 确认所有的测试都是通过的 `rush test`
|
||||
6. 开发完成后，运行 `rush change` 命令，编写 changelog 并提交
|
||||
7. 提交所有代码，并在 Github 创建 Pull Request，邀请其他人进行 review
|
||||
|
||||
## 拥抱 VisActor 社区
|
||||
|
||||
在你为 VisActor 贡献代码之余，我们鼓励你参与其他让社区更加繁荣的事情，比如：
|
||||
|
||||
1. 为项目的发展、功能规划 等提建议。
|
||||
2. 创作文章、视频，开办讲座来宣传 VisActor。
|
||||
3. 撰写推广计划，同团队一同执行。
|
||||
|
||||
VisActor 也在努力帮助参与社区建设的同学一同成长，我们计划（但不限于，期待大家更多的建议）提供如下帮助：
|
||||
|
||||
1. 以 VisActor 为基础的数据可视化研发培训，帮助参与的同学在编程技能、可视化理论、架构设计等多个方面快速成长。
|
||||
2. 定期评选“代码贡献奖”和“社区推广奖”。
|
||||
3. 组织社区成员参与开源活动。
|
||||
|
||||
@ -106,7 +106,7 @@ git rebase develop
|
||||
- Submit the updated code to your own branch.
|
||||
|
||||
```
|
||||
git push upstream docs/add-funnel-demo
|
||||
git push origin docs/add-funnel-demo
|
||||
```
|
||||
|
||||
### Step 5: Submit Pull Request
|
||||
|
||||
@ -104,7 +104,7 @@ git rebase develop
|
||||
- 把更新代码提交到自己的分支中:
|
||||
|
||||
```
|
||||
git push upstream docs/add-funnel-demo
|
||||
git push origin docs/add-funnel-demo
|
||||
```
|
||||
|
||||
### Step5：提交 Pull Request
|
||||
|
||||
Loading…
Reference in New Issue
Block a user