@hrcd/cli-starter

cli-starter

This repository is a template repository for creating new repositories with everything you need to get started.

Usage

Install package:

# ✨ Auto-detect
npx nypm install @hrcd/cli-starter

# npm
npm install @hrcd/cli-starter

# yarn
yarn add @hrcd/cli-starter

# pnpm
pnpm install @hrcd/cli-starter

# bun
bun install @hrcd/cli-starter

Development

Before you start, you can use the ./scripts/rename.sh script to rename all @hrcd/cli-starter occurrences in the repository to your new repository name.

Local development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using bun install

Contributing

To start contributing, you can follow these steps:

• First raise an issue to discuss the changes you would like to make.
• Fork the repository.
• Create a branch using conventional commits and the issue number as the branch name. For example, feat/123 or fix/456.
• Make changes following the local development steps.
• Commit your changes following the Conventional Commits specification.
• If your changes affect the code, run tests using bun run test.
• Create a pull request following the Pull Request Template.
  • To be merged, the pull request must pass the tests/workflow and have at least one approval.
  • If your changes affect the documentation, make sure to update it.
  • If your changes affect the code, make sure to update the tests.
• Wait for the maintainers to review your pull request.
• Once approved, the pull request will be merged in the next release !

Published under the APACHE license. Made by @HugoRCD and community 💛

🤖 auto updated with automd (last updated: Sun Mar 31 2024)