NPM Package Template

Use this template to quickly set up and release npm packages with ease. This template is configured to automate the release process using semantic-release and provides commitizen support for standardized commit messages.

Getting Started

To get started with this template, follow these steps:

1. Click the "Use this template" button at the top of the repository to create a new repository based on this template.

2. Clone the newly created repository to your local machine:

   1git clone https://github.com/your-username/your-package.git

3. Change into the project directory:

   1cd your-package

4. Install the project dependencies:

   1yarn install

Initializing Husky

Husky is a tool that helps you set up Git hooks easily. These hooks can run checks or tasks before you commit or push changes. This template uses Husky to enforce commit message conventions.

To initialize Husky, run the following command:

1npx husky-init && yarn

Initializing Commitizen

Commitizen is a tool that helps you write consistent and conventional commit messages. It prompts you to fill in the required commit message fields, ensuring your commits are well-structured.

To initialize Commitizen with this template, run the following command:

1npx commitizen init cz-conventional-changelog --yarn --dev --exact --force

• Github Actions branch change: You have to modify the banch name to the branch name in which you want the release job to start.

name: Release
on:
  push:
    branches:
      - <<release branch name>>

• Custom TypeScript Configuration: You can modify the TypeScript configuration in tsconfig.json to suit your project's needs.

Contributing

We welcome contributions to this project. If you have any bug fixes, feature additions, or improvements, please open an issue or submit a pull request. Make sure to follow the commit message conventions for your pull requests.

License

This project is licensed under the MIT License.

Acknowledgments

• Semantic Release
• Commitizen
• Husky
• ESLint
• Prettier
• Jest
• TypeScript

Support

If you have any questions or need assistance, please feel free to reach out through the GitHub Issues section of this repository.

Happy coding! 🚀