Skip to content

Commit

Permalink
docs: add contributing.md into docs/.../contribution-guidelines.md
Browse files Browse the repository at this point in the history
  • Loading branch information
harttle committed Jun 3, 2023
1 parent 87e83b6 commit e9da7f3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 23 deletions.
17 changes: 5 additions & 12 deletions docs/source/tutorials/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,19 @@ Starring LiquidJS is the most important and easiest way to support us: boost its

## Show Me Your Code

**Code Style**: LiquidJS applies [standard](https://github.com/standard/eslint-config-standard) and [@typescript-eslint/recommended](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.json) rules, make sure it's still valid before commit:
Getting started and building is described in [CONTRIBUTING.md](https://github.com/harttle/liquidjs/blob/master/CONTRIBUTING.md).

```bash
npm run lint
```
**Code Style**: LiquidJS applies [standard](https://github.com/standard/eslint-config-standard) and [@typescript-eslint/recommended](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.json) rules.

**Testing**: Make sure test cases pass with your patch merged:

```bash
npm test
```
**Testing**: Make sure test cases pass with your patch merged by running `npm test`

**Commit Message**: Please align to [the Angular Commit Message Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits), especially note the [type identifier](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type), on which semantic-release bot depends.

**Backward-Compatibility**: please be backward-compatible. LiquidJS is used by multiple layers of softwares, including underlying libraries, compilers, site generators and Web servers. It's not easy to do a major upgrade for most of them.

## Financial Support

LiquidJS is Open Source and Free. To help it live and thrive, please consider contribute on [Open Collective][oc] or [Patreon][pt]. To acknowledge your contribution, your name and avatar will be listed here, on LiquidJS [homepage](https://liquidjs.com/) and on [Github README][liquidjs]. Please provide your Github ID by openning an issue or contacting me through Twitter (harttleharttle), I can help add you into [the contributors table](https://github.com/harttle/liquidjs#contributors-).
LiquidJS is Open Source and Free. To help it live and thrive, please consider contribute on [Open Collective][oc]. To acknowledge your contribution, your name and avatar will be listed here, on LiquidJS [homepage](https://liquidjs.com/) and on [Github README][liquidjs]. Please provide your Github ID by openning an issue or contacting me through Twitter (harttleharttle), I can help add you into [the contributors table](https://github.com/harttle/liquidjs#contributors-).

### Backers
If you personally like LiquidJS and find it's useful to you, you can become a backer!
Expand All @@ -38,8 +32,7 @@ If LiquidJS is benefiting your business/company, please sponsor us to make it be

<object type="image/svg+xml" data="https://opencollective.com/liquidjs/sponsors.svg?avatarHeight=72"></object>

[oc]: https://opencollective.com/liquidjs/contribute/backer-ii-10666/checkout
[pt]: https://www.patreon.com/harttle
[oc]: https://opencollective.com/liquidjs/contribute/backer-10665/checkout
[shopify/liquid]: https://shopify.github.io/liquid/
[caniuse-promises]: http://caniuse.com/#feat=promises
[pp]: https://github.com/taylorhakes/promise-polyfill
Expand Down
15 changes: 4 additions & 11 deletions docs/source/zh-cn/tutorials/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,19 @@ Star 是支持 LiquidJS 最重要的方式,也是最简单的方式:通过

## 发起 Pull Request

**代码风格**:LiquidJS 采用 [standard](https://github.com/standard/eslint-config-standard)[@typescript-eslint/recommended](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.json) 规则,提交前确保可以通过风格检查:
开发和构建描述在这篇文档里 [CONTRIBUTING.md](https://github.com/harttle/liquidjs/blob/master/CONTRIBUTING.md)

```bash
npm run lint
```
**代码风格**:LiquidJS 采用 [standard](https://github.com/standard/eslint-config-standard)[@typescript-eslint/recommended](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.json) 规则。

**测试**:确保你改动之后测试仍然可以通过:

```bash
npm test
```
**测试**:确保你改动之后测试仍然可以通过 `npm test`

**提交消息**:请遵守 [Angular 提交消息规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits),尤其注意 [type 标识](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type),semantic-release 机器人依赖这个标识自动发布。

**向后兼容**:请考虑向后(之前的旧的版本)兼容。LiquidJS 被用于很多层的软件,包括底层库、编译器、站点生成器、 Web 服务器。对多数最终用户来说,驱动或请求整个系统做一次主版本升级是很难办到的。

## 资金支持

LiquidJS 是开源和免费的,但支持 [Open Collective][oc] [Patreon][pt] 赞助,作为感谢你的名字和头像(或 Logo)会展示在这里,[LiquidJS 首页](https://liquidjs.com/)[Github README][liquidjs]
LiquidJS 是开源和免费的,但支持 [Open Collective][oc] 赞助,作为感谢你的名字和头像(或 Logo)会展示在这里,[LiquidJS 首页](https://liquidjs.com/)[Github README][liquidjs]

### 支持者
如果你喜欢 LiquidJS,希望支持我们,你可以成为 Open Collective Backer!
Expand All @@ -39,7 +33,6 @@ LiquidJS 是开源和免费的,但支持 [Open Collective][oc] 或 [Patreon][p
<object type="image/svg+xml" data="https://opencollective.com/liquidjs/sponsors.svg?avatarHeight=72"></object>

[oc]: https://opencollective.com/liquidjs/
[pt]: https://www.patreon.com/harttle
[shopify/liquid]: https://shopify.github.io/liquid/
[caniuse-promises]: http://caniuse.com/#feat=promises
[pp]: https://github.com/taylorhakes/promise-polyfill
Expand Down

0 comments on commit e9da7f3

Please sign in to comment.