Skip to content

Contributing ​

Setting up ​

You need Node 22.18 or newer and Corepack, which comes with Node.

bash
git clone https://github.com/nepdate/nepdate.git
cd nepdate
corepack enable
pnpm install

Useful commands ​

CommandWhat it does
pnpm devRuns the playground at http://localhost:5180
pnpm testRuns the tests
pnpm verifyRuns everything CI runs: format, lint, types, tests, build, package and size checks
pnpm --filter @nepdatejs/docs devRuns these docs at http://localhost:5181
pnpm check:docsChecks every code sample in the docs against the packages

Run pnpm verify before you open a pull request.

Correcting a date ​

If a BS year in the table is wrong, or you have a year's holiday list, open an issue and link to the published calendar or government notice. Data changes need a source people can check.

Improving these docs ​

Pages live in apps/docs as Markdown, and every page has an "Edit this page" link.

Code samples are tested. pnpm check:docs type-checks each sample, and a line ending in // → value is run and compared with the real result, so write expected results that way:

ts
import { bsDate, formatDate } from '@nepdatejs/core';

formatDate(bsDate(2083, 7, 1), 'long'); // → '1 Kartik 2083'

Reporting a security issue ​

Please don't open a public issue. See SECURITY.md.

Released under the MIT licence.