From 77ee5fbd41d9991346df4eb90dc550744f410d5d Mon Sep 17 00:00:00 2001 From: Jakub Hampl Date: Fri, 23 Feb 2024 14:24:27 +0000 Subject: [PATCH] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index f0572ab..03e913c 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,7 @@ If you are proposing a new function be added, please adhere to the following.. 1. Include [documentation](http://package.elm-lang.org/help/documentation-format) and make sure your documentation has a code snippet demonstrating what the function does. We use [elm-verify-examples](https://github.com/stoeffel/elm-verify-examples) in our CI set up which verifies our examples that our example code is correct, so please take advantage of that. 2. Provide a detailed use case where your new function would be useful. Also, compare your new function to the best possible implementation that doesn't use your function. 3. Add tests. - -If you are improving existing functions please demonstrate the performance gains in something like [Ellie](https://ellie-app.com/) and by using a benchmark library like [this one](https://github.com/elm-explorations/benchmark). +4. For performance improvements write benchmarks into the benchmarks directory. ## Contributors