james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-11 18:59:05 +00:00
Code Activity
classcharts-api-js/CONTRIBUTING.md
James Cook bb986b71a8 chore: add contributing.md
2023-09-13 22:24:12 +01:00

1.1 KiB
Raw Permalink Blame History

Contributing

Thanks for taking the time to contribute to this project! If you'd like to learn how the API works, check out the (unofficial) documentation.

Dev Setup

Requirements

  • Deno (for the main development)
  • Node.js (for testing the NPM package)
  • pnpm (for installing dependencies for the NPM package)

Instructions

To contribute to this repo, you will need to fork the repo first. Click the fork button in the top right corner of the repo page.

  1. Clone your forked repo to your local machine
git clone https://github.com/<your_github_username>/classcharts-api-js.git
cd classcharts-api-js

Testing

When adding a new function, if you can, add a test for it. Tests are located in [FILENAME]_test.ts.
To run the tests, run:

deno test -A

The NPM package will automatically be tested when you build it.

Building

The Deno module is already built but to compile and test the NPM package, run:

deno task npm 1.0.0

Make sure to replace 1.0.0 with the version number.