Eric Cornelissen
e26bf79ffc
* Draft contributors.md update This is a proposed updated to the contributors.md document inspired by the contributing guidelines of the actions/cache project [1]. There are some differences, most notable the inclusion of "Development Details" which explains and motivates the development tools (to an extend). -- 1. https://github.com/actions/cache/blob/eed9cfe64d00dd64cbb36bec915d41dd6fab9f6c/CONTRIBUTING.md * Split Contributing Guidelines and Development Handbook Split the "Contributing Guidelines" currently found in docs/contributors.md into a CONTRIBUTING.md file, containing the Contributing Guidelines, and a docs/development.md file, containing details on how the development/testing of this project works.
6 lines
547 B
Markdown
6 lines
547 B
Markdown
# Development Handbook
|
|
|
|
This project is written in [TypeScript](https://www.typescriptlang.org/), a typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get a consistent code style.
|
|
|
|
Because of how GitHub Actions are run, the source code of this project is transpiled from TypeScript into JavaScript. The transpiled code (found in `lib/`) is subsequently compiled using [NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to avoid having to include the `node_modules/` directory in the repository.
|