From ccb173f2b3ed61ebe162631addcb5e84114571b8 Mon Sep 17 00:00:00 2001 From: Sebastian Martinez Date: Tue, 23 May 2023 09:31:10 +0200 Subject: [PATCH] Update CONTRIBUTING guidelines Signed-off-by: Sebastian Martinez --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be518ec39..8379bdde6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,14 +3,15 @@ Contributions are very welcome. When contributing code, please follow these simple guidelines. -* Make sure you run `npx eslint .` to check for code formatting problems. - You can use the `--fix` flag to automatically fix any issues the linter catches. +* Make sure you run `npm run check` for code formatting problems. +* Run our test suite `npm run test:*` to avoid regressions or bugs. * Before adding any code dependencies, check with the maintainers if this is okay. * Write properly formatted comments: they should be english sentences, eg: // Return the current UNIX time. * Make sure all commits are signed off, using `git commit -s`. +* Sign all your comments with your public key, using `git commit -S`. * Follow the guidelines when proposing code changes (see below). * Write properly formatted git commits (see below). * Read the DCO.