From cc8851e56f2c39383b56f507d36331cda172867e Mon Sep 17 00:00:00 2001 From: harttle Date: Sat, 5 Oct 2019 11:37:18 +0800 Subject: [PATCH] doc: add Contribute Guidelines --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a95f56d90..8ad0d08d9 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,12 @@ Thanks goes to these wonderful people: [![donate to liquidjs collective](https://opencollective.com/webpack/donate/button@2x.png?color=blue)](https://opencollective.com/liquidjs/donate) +## Contribute Guidelines + +* **Code Style**: , `npm run lint` to check locally. +* **Testing**: make sure test cases still pass, use `npm test` to check locally. +* **Commit Message**: align to [The Angular Commit Message Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits), especially the [Type identifier](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type), to allow the semantic-release bot do the work. + [shopify/liquid]: https://shopify.github.io/liquid/ [caniuse-promises]: http://caniuse.com/#feat=promises [pp]: https://github.com/taylorhakes/promise-polyfill