Skip to content

Commit

Permalink
docs: add the CONTRIBUTING.md (#416)
Browse files Browse the repository at this point in the history
* Create CONTRIBUTING.md

* docs: update the CONTRIBUTING.md

* docs: add the CONTRIBUTION.en-US.md

* docs: enhance condition fill field  explanation (#423)

* docs(interaction): fix cannot show live demo (#427)

* docs: 📝 update the CONTRIBUTING

* Create CONTRIBUTING.md

* docs: update the CONTRIBUTING.md

* docs: add the CONTRIBUTION.en-US.md

* chore: rebase the master

Co-authored-by: Wenjun Xu <906626481@qq.com>
Co-authored-by: Jinke Li <a1231236677287@163.com>
  • Loading branch information
3 people committed Oct 11, 2021
1 parent 29cfb3b commit 86ec354
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 6 deletions.
5 changes: 1 addition & 4 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
{
"default": true,
"no-inline-html": false,
"line-length": {
"line_length": 200,
"tables": false
},
"line-length": false,
"single-h1": false,
"first-line-h1": false,
"no-empty-links": false
Expand Down
60 changes: 60 additions & 0 deletions CONTRIBUTING.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@

<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> [简体中文](./CONTRIBUTING.md)
English

## Any kind of contribution is welcome

"My code level is not good ." "Will it be despised?" "Will it be bad?" Don't worry. Feel free to contribute.

We welcome any contribution, whether it's a typo correction or a friendly suggestion, whether it's submitted by [Issue](https://github.com/antvis/S2/issues/new/choose),
a cool [pull request](https://github.com/antvis/S2/pulls), or a DingTalk group discussion, participate in [discussions](https://github.com/antvis/S2/discussions), look forward to seeing your profile picture in [Contributor List](https://github.com/antvis/S2/graphs/contributors).

## Branch Management

Currently, we are developing based on the `master` branch. Please check out a branch based on `master,` and Pull Request if you have any modifications. We will review your `PR` for the first time and give you feedback.

## Report bugs

We are sorry to push bugs. And we would appreciate that if you could report them to us. To save time on the communication, please give details about the bug as much as possible.

### Bad case

![preview](https://gw.alipayobjects.com/zos/antfincdn/j0jUvKwT%26/dd59fe64-7108-4ad7-a544-e19d79eea890.png)

### Good case

1. First select [Bug report]

![preview](https://gw.alipayobjects.com/zos/antfincdn/oAnzfiVl2/9d83b3e8-b05c-4475-b736-92c45448546a.png)

2. Fill in the relevant information according to the Issue template.

We are sorry that these steps are a bit redundant. Since every user uses S2 in different situations, system environment, software version, specific steps to reproduce the bug could help us solve the issue in time.

![preview](https://gw.alipayobjects.com/zos/antfincdn/05O3p5nE5/d0d4b120-e5aa-4b51-918b-8a573f8fb794.png)

## Pull Request

1. Fork the project and clone it (or use Github's Codespace function, which is very convenient).
2. Installation dependency: `yarn bootstrap` or `yarn`.
3. Commit your changes, and please follow [AngularJS Git Commit Message Conventions] (<https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w>).
4. If your change is a bug fix, you can add `close #issue number` after the submission information so that after the pr merge, the related issue could be closed automatically. eg: `fix: render bug close #123`.
5. Make sure to add the related unit test.
6. After all Lint and Test checks are passed, and the review is passed, we will merge your pr.

![preview](https://gw.alipayobjects.com/zos/antfincdn/ssOxFrycD/86339514-5f9a-4101-8690-e47c97cd8af5.png)

## Development Process

We use `yarn@v1` as package management.

```bash
npm i -g yarn
```

1. `yarn bootstrap`: Installation dependency.
2. `yarn site:bootstrap`: Install site related dependencies.
3. `yarn site:start`: Starts the local `S2` website.
4. `yarn core:start`: Debug and test.
5. `yarn build`: Builds `S2`, outputs are`umd`, `esm` and `lib` directories.
6. `yarn test`: Run unit tests.
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@

<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> 简体中文 | [English](./CONTRIBUTING.en-US.md)

如果你恰好看到了这篇文章,你一定是希望对这个项目贡献自己的一份力量

## 欢迎任何形式的贡献

"我代码水平不行", "会不会受到鄙视?", "会不会不太好?", 放心,不存在的!

我们欢迎任何形式的贡献,不管是一个错别字的修改,还是一次友好的建议,不管是通过 提交 [Issue](https://github.com/antvis/S2/issues/new/choose)
还是一个帅气 [pull request](https://github.com/antvis/S2/pulls), 亦或是一次钉钉群的讨论,参与 [discussions](https://github.com/antvis/S2/discussions) 的讨论,期待在 [贡献者列表](https://github.com/antvis/S2/graphs/contributors) 里看见你的头像。

## 分支管理

目前,我们基于 `master` 分支开发,有任何修改,请基于 `master` 拉一个分支,然后通过 `PR` 的形式,我们集成了钉钉机器人,会第一次时间 review 你的 PR, 给与反馈

## 提交 Bug

很抱歉又写了一些 bug, 对于没一个 bug report 我们都会非常感激。为了提高沟通效率,请尽量多一些细节描述。

### 错误示范

![preview](https://gw.alipayobjects.com/zos/antfincdn/j0jUvKwT%26/dd59fe64-7108-4ad7-a544-e19d79eea890.png)

### 推荐步骤

1. 首先选择 [Bug report]

![preview](https://gw.alipayobjects.com/zos/antfincdn/oAnzfiVl2/9d83b3e8-b05c-4475-b736-92c45448546a.png)

2. 按照 Issue 模板 填写相关的信息,是的,这些步骤稍微一些繁琐,但确实必须的,每个用户使用的场景都不同,系统环境,软件版本,又或是需要一些特定的步骤才能复现 bug, 这个时候说清楚,可以节省大家的时间呢~

![preview](https://gw.alipayobjects.com/zos/antfincdn/05O3p5nE5/d0d4b120-e5aa-4b51-918b-8a573f8fb794.png)

## Pull Request

1. fork 项目 并 clone 下来 (或者使用 Github 的 Codespace 功能,非常方便)
2. 安装依赖:`yarn bootstrap` 或者 `yarn`
3. 提交你的改动,commit 请遵守 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w)
4. 如果你的改动是修复 bug, 还可以在提交信息后面加上 `close #issue 号`, 这样可以在 pr 合并后,可以自动关闭对应的 issue, 比如 `fix: render bug close #123`
5. 确保加上了对应的单元测试
6. 所有 Lint 和 Test 检查通过后,并且 review 通过,我们会合并你的 pr.

![preview](https://gw.alipayobjects.com/zos/antfincdn/ssOxFrycD/86339514-5f9a-4101-8690-e47c97cd8af5.png)

## 开发流程

我们使用 `yarn@v1` 作为包管理

```bash
npm i -g yarn
```

1. `yarn bootstrap` 安装依赖
2. `yarn site:bootstrap` 安装网站相关依赖
3. `yarn site:start` 启动本地的 `S2` 网站
4. `yarn core:start` 可视化的方式调试测试
5. `yarn build` 构建 `S2`, 输出 `umd`, `esm``lib` 目录
6. `yarn test` 运行单元格测试
2 changes: 1 addition & 1 deletion packages/s2-core/src/components/switcher/util.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { filter, flatten, isEmpty, isNil, map, mapValues } from 'lodash';
import { filter, flatten, isNil, map, mapValues } from 'lodash';
import { DraggableLocation } from 'react-beautiful-dnd';
import {
FieldType,
Expand Down
1 change: 0 additions & 1 deletion packages/s2-core/src/facet/base-facet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import {
KEY_GROUP_ROW_RESIZE_AREA,
MAX_SCROLL_OFFSET,
MIN_SCROLL_BAR_HEIGHT,
InteractionStateName,
} from '@/common/constant';
import type { S2WheelEvent, ScrollOffset } from '@/common/interface/scroll';
import { getAllPanelDataCell } from '@/utils/getAllPanelDataCell';
Expand Down

0 comments on commit 86ec354

Please sign in to comment.