Skip to content

Commit

Permalink
Merge pull request #273 from ahmed-hritani/update-cont
Browse files Browse the repository at this point in the history
Update contributing docs to save people's time
  • Loading branch information
iambumblehead authored Nov 13, 2023
2 parents a7f927d + d3796d4 commit 9afa807
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 9afa807

Please sign in to comment.