From 0d1b54a7490e2b8b65164ef4ed0e48d2ca230ba4 Mon Sep 17 00:00:00 2001 From: Raul Melo Date: Sun, 28 Jan 2024 14:24:37 +0100 Subject: [PATCH] README changes --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 223bd89..c5ac130 100644 --- a/README.md +++ b/README.md @@ -38,3 +38,25 @@ $ node-versions --latest $ node-versions --latest-of 20 $ node-versions --lts ``` + +## Contributing + +1. Make sure to have bun v1.0.25 or higher +2. clone this repository +3. install the dependencies: + ``` + bun install + ``` +4. Do the changes on the files in `src/*`; +5. run the dev command: + ``` + bun run dev + ``` + +If your change must be published: + +1. Run `bun changeset` +1. Select the type of version the change includes following semver logic +1. Commit the changeset file alongside with your changes +1. Open a PR +1. Wait until it gets reviewed and approved