From e9da7f39de1623b8e704231dd6d2661b64ac63f0 Mon Sep 17 00:00:00 2001 From: Harttle Date: Sun, 4 Jun 2023 02:13:48 +0800 Subject: [PATCH] docs: add contributing.md into docs/.../contribution-guidelines.md --- .../source/tutorials/contribution-guidelines.md | 17 +++++------------ .../zh-cn/tutorials/contribution-guidelines.md | 15 ++++----------- 2 files changed, 9 insertions(+), 23 deletions(-) diff --git a/docs/source/tutorials/contribution-guidelines.md b/docs/source/tutorials/contribution-guidelines.md index a9eeb86b7a..63a172d040 100644 --- a/docs/source/tutorials/contribution-guidelines.md +++ b/docs/source/tutorials/contribution-guidelines.md @@ -8,17 +8,11 @@ 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. @@ -26,7 +20,7 @@ npm test ## 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! @@ -38,8 +32,7 @@ If LiquidJS is benefiting your business/company, please sponsor us to make it be -[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 diff --git a/docs/source/zh-cn/tutorials/contribution-guidelines.md b/docs/source/zh-cn/tutorials/contribution-guidelines.md index 961b4cd12c..d94702ef50 100644 --- a/docs/source/zh-cn/tutorials/contribution-guidelines.md +++ b/docs/source/zh-cn/tutorials/contribution-guidelines.md @@ -8,17 +8,11 @@ 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 机器人依赖这个标识自动发布。 @@ -26,7 +20,7 @@ npm test ## 资金支持 -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！ @@ -39,7 +33,6 @@ LiquidJS 是开源和免费的，但支持 [Open Collective][oc] 或 [Patreon][p [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