Skip to content

Add README.md #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drebrez merged 4 commits into from
Mar 18, 2025
Merged

Add README.md #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b96102a
Create README.md
drebrez Mar 18, 2025
1f30cca
Update README.md
drebrez Mar 18, 2025
a2009c1
Update CHANGELOG.md
drebrez Mar 18, 2025
d43a1ac
fix layout
drebrez Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 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 [@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

- 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.