From b96102a23ca295b1180fbbff350f319e96fe18d9 Mon Sep 17 00:00:00 2001 From: Daniele Debernardi Date: Tue, 18 Mar 2025 14:54:35 +0100 Subject: [PATCH 1/4] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3967b93 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# javascript-utils + +This is a collection of utilities that we have created to help with our development process. We have decided to open source these utilities in the hopes that they will be useful to others. + +## Usage +To use these utilities, simply add the npm package (https://www.npmjs.com/package/@neolution-ch/javascript-utils) to your project and use the desired functions in your source code. + +## Contributing +If you would like to contribute to this project, please submit a pull request. + +### Guidelines + +- Use a filename that fits what the utility is doing. If you introduce a new file, choose a name that fits your utility but is still generic enough to hold similar utilities that can be added later alongside your addition. +- Add tests to your utilities and strive to cover many different usage scenarios and parametrization and high code coverage. + +## Releases +Due to the nature of this project as a loosely connected collection of utilities, it's important to be strict about following [SemVer](https://semver.org/) to communicate possible breaking changes to the users of this library via version number. + +Equally as important is to be precise about the changes made in each release and maintain the [CHANGELOG.md](CHANGELOG.md) according to the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format so users of this library can see easily where changes were made. From 1f30cca0a70ac74403c03630c027392c970620c9 Mon Sep 17 00:00:00 2001 From: Daniele Debernardi Date: Tue, 18 Mar 2025 14:56:49 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3967b93..c7623d9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This is a collection of utilities that we have created to help with our development process. We have decided to open source these utilities in the hopes that they will be useful to others. ## Usage -To use these utilities, simply add the npm package (https://www.npmjs.com/package/@neolution-ch/javascript-utils) to your project and use the desired functions in your source code. +To use these utilities, simply add the [@neolution-ch/javascript-utils](https://www.npmjs.com/package/@neolution-ch/javascript-utils) npm package to your project and use the desired functions in your source code. ## Contributing If you would like to contribute to this project, please submit a pull request. From a2009c174b8230c16b1858fb4cd710183d12dd22 Mon Sep 17 00:00:00 2001 From: Daniele Debernardi Date: Tue, 18 Mar 2025 14:57:23 +0100 Subject: [PATCH 3/4] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a0f48c1..67bb997 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Code coverage with 100% threshold +- README.md ## [1.2.0] - 2025-01-13 From d43a1ac6f1bfa10c220fb80c910071b2ef33fe13 Mon Sep 17 00:00:00 2001 From: Daniele Debernardi Date: Tue, 18 Mar 2025 15:13:38 +0100 Subject: [PATCH 4/4] fix layout --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c7623d9..4d1c881 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,11 @@ This is a collection of utilities that we have created to help with our development process. We have decided to open source these utilities in the hopes that they will be useful to others. ## Usage + To use these utilities, simply add the [@neolution-ch/javascript-utils](https://www.npmjs.com/package/@neolution-ch/javascript-utils) npm package to your project and use the desired functions in your source code. ## Contributing + If you would like to contribute to this project, please submit a pull request. ### Guidelines @@ -14,6 +16,7 @@ If you would like to contribute to this project, please submit a pull request. - Add tests to your utilities and strive to cover many different usage scenarios and parametrization and high code coverage. ## Releases + Due to the nature of this project as a loosely connected collection of utilities, it's important to be strict about following [SemVer](https://semver.org/) to communicate possible breaking changes to the users of this library via version number. Equally as important is to be precise about the changes made in each release and maintain the [CHANGELOG.md](CHANGELOG.md) according to the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format so users of this library can see easily where changes were made.