From d3796d433b6d3a161b7492fdb196f5d3d9ec24e2 Mon Sep 17 00:00:00 2001 From: Ahmed Hritani Date: Mon, 13 Nov 2023 12:35:21 +0100 Subject: [PATCH] Update contributing docs to save people's time --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ede358b2..4c1db66d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,5 +4,10 @@ If `esmock` is failing for you, feel free to submit a PR that reproduces the iss Please do not submit PRs to convert esmock to typescript or add build scripts. Typescript and build scripts are fine, however, esmock's current setup is ideal for me now. +When it comes to adding examples to README, please follow the constraints below: +- The example should work. It should be possible to write a real unit-test that passes with the example, +- Each line less than 70 characters wide. This is a special optimization for the README so the examples fit inside most laptop screens without scrollbars, +- The example should be slightly interesting, if possible, and should use a unicode emoji + [0]: https://github.com/iambumblehead/esmock/tree/master/tests