⚠️ Attention Developers ⚠️ Template use checklist

• [ ] Request a GitHub organisation admin to create a repository using this template. (Optional. Can be done later. Workflows will fail until this is done.)

  • [ ] Has been marked public (if required)

• [ ] New repository configuration:

  • [ ] Give MakerX Engineering write access under the repository settings.
  • [ ] Add branch protection rules for main:
    • [ ] No direct pushes, no force pushes
  • [ ] Check Limit to users explicitly granted read or higher access in Code review limits under Moderation options.
  • [ ] Check Accept content reports from collaborators and prior contributors in Reported content under Moderation options.
  • [ ] Tick Automatically delete head branches under General.
  • [ ] Add relevant tags conforming to GitBook.

• [ ] Check out the source code of your newly created repository.

• [ ] Run the PowerShell script name-my-package.ps1.

  .\name-my-package.ps1
  or
  .\name-my-package.ps1 -PackageName "" -PackageTitle "" -PackageDescription ""

• [ ] Delete the name-my-package.ps1 script.

• [ ] Add the keywords to the package.json file.

• [ ] Run npm i to generate a lock file.

• [ ] Add/Write your package code.

• [ ] Fill in the usage section of this file.

• [ ] Remove this checklist and surrounding section.

• [ ] Understand that the NPM package will be PUBLIC.

• [ ] Configure NPM for trusted publishing Blog

• [ ] Promote your package. 🎉

⚠️ Remember, this repository uses conventional commits and semantic-release to automate package publication. Your commit messages are critical, and the build process will lint them.

Attribution

This template was based on the great work of Ryan Sonshine

TS NPM Template Package Sandbox (ts-npm-package-template-sandbox)

Used for template change testing

Install

npm install ts-npm-package-template-sandbox --save-dev

Code docs

** 🚨 TODO 🚨 **

View the source code documentation here

Usage

** 🚨 TODO 🚨 **

The usage section should be minimal. Enough to demo the package, but not overload the reader