Skip to content

Shared code to calculate taxes for events, products and services (VAT)

License

Notifications You must be signed in to change notification settings

opencollective/opencollective-taxes

Repository files navigation

Open Collective Taxes

codecov GitHub Discord

Foreword

If you see a step below that could be improved (or is outdated), please update the instructions. We rarely go through this process ourselves, so your fresh pair of eyes and your recent experience with it, makes you the best candidate to improve them for other users. Thank you!

Development

Prerequisite

  1. Make sure you have Node.js version >= 18.
  • We recommend using nvm: nvm use.

Install

We recommend cloning the repository in a folder dedicated to opencollective projects.

git clone [email protected]:opencollective/opencollective-taxes.git opencollective/taxes
cd opencollective/taxes
npm install

Release

  1. Bump version with npm version {patch|minor|major}
  2. Run npm run build
  3. Run npm publish

Contributing

Code style? Commit convention? Please check our Contributing guidelines.

TL;DR: we use Prettier and ESLint, we do like great commit messages and clean Git history.

Tests

You can run the tests using npm test or npm run test:watch (for TDD).

Discussion

If you have any questions, ping us on Discord or Twitter (@opencollect).