UNPKG

@cashu/cashu-ts

Version:

cashu library for communicating with a cashu mint

github.com/cashubtc/cashu-ts

cashubtc/cashu-ts

19 lines (12 loc) • 1.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Contribution Guide ## API-Extractor This library runs [API-Extractor](https://api-extractor.com/) in its CI pipeline to ensure API changes are intentional and properly reviewed. The process involves two kinds of reports: - `/temp/*.md`: The reports in the `temp` directory are created on your local machine and compared against the status quo report. These must not be commited. - `/etc/cashu-ts.api.md`: This report is the status quo report and is included in the repository. Local versions are compared against this report to detect changes. There are two scripts to interact with the API-Extractor: `npm run api:check` This command will create an API report in the `/temp` directory and compare it against the current status quo report (`/etc/cashu-ts.api.md`). The `/temp` report is not supposed to be commited. If the two differ, the public API has changed and you will see a warning in the console. `npm run api:update` This command will create an API report in the `/temp` directory AND update the status quo report in `/etc`. If there are changes to the status quo report commit the updated report. Otherwise CI will fail.