open-index/open-npm huggingface dataset:
npm package: @mattwilson1024/npm-test-1
Description: A simple NPM package
Author: Matt Wilson
Latest version: 1.5.0

[![GitHub release](https://img.shields.io/github/release/mattwilson1024/npm-test-1.svg)](https://GitHub.com/mattwilson1024/npm-test-1/releases/)
![Tests](https://github.com/mattwilson1024/npm-test-1/workflows/Tests/badge.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![GitHub license](https://img.shields.io/github/license/mattwilson1024/npm-test-1.svg)](https://github.com/mattwilson1024/npm-test-1/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/mattwilson1024/npm-test-1.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/mattwilson1024/npm-test-1/stargazers/)

# npm-test-1

This is an example repo, built to test the following:

- A very basic TypeScript library, including generating type definitions on build
- Simple [Jest](https://jestjs.io/) setup, with tests running in CI on [Github Actions](https://github.com/features/actions)
- Automated deployment to NPM using [semantic-release](https://github.com/semantic-release/semantic-release)
- Enforce that git commits follow the [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/) standard in a git hook, using [commitlint](https://commitlint.js.org/#/guides-local-setup) and [husky](https://github.com/typicode/husky)

## Recommended Learning Resources

- [YouTube: Using semantic-release with GitHub Actions by Zeke Sikelianos](https://www.youtube.com/watch?v=rCXq86FOlzQ)
- [YouTube: GitHub Actions demo by Zeke Sikelianos ](https://www.youtube.com/watch?v=TwkAD_yljVw)
- [Commitlint setup instructions](https://commitlint.js.org/#/guides-local-setup)
- [Medium: How to automate your releases, versioning & release notes like a boss by Khaled Osman](https://itnext.io/automate-your-releases-versioning-and-release-notes-with-semantic-release-d5575b73d986)