From c1a41a06ea446eedc01784d75523886bd98fa261 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sun, 23 Oct 2022 11:15:11 +0200 Subject: [PATCH] CONTRIBUTING.md: small refinements MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- .vscode/settings.json | 2 ++ CONTRIBUTING.md | 11 +++++------ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index c4fb5936..65ddc6e9 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -11,12 +11,14 @@ "Gitter", "inheritDoc", "lcov", + "libuv", "loglevel", "markdownlint", "microjob", "microtime", "mochawesome", "MYBENCH", + "octocat", "piment", "poolifier", "poolify", diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d3e4fba..25e44a18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,27 +3,26 @@ [![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard) This repo use standard js style, please use it if you want to contribute Take tasks from todo list, develop a new feature or fix a bug and do a pull request. -Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project +Another thing that you can do to contribute is to build something on top of poolifier and link poolifier to your project Please do your PR on **master** branch. **How to run unit tests and coverage** ```bash - npm test - npm run coverage + npm test && npm run coverage ``` -**How to check if your new code is standard style** +**How to check if your new code is standard JS style** ```bash npm run lint ``` -**How to lint and format to standard JS your code** +**How to format and lint to standard JS style your code** ```bash - npm run lint:fix + npm run format && npm run lint:fix ``` ### Project pillars -- 2.34.1