actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-13 13:07:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Draft contributors.md update (#97)

Browse Source 
* 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. eed9cfe64d/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.
This commit is contained in:
Eric Cornelissen
2020-09-15 16:57:36 +03:00
committed by GitHub
parent bab130482f
commit e26bf79ffc
3 changed files with 31 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/development.md Normal file
View File

@@ -0,0 +1,5 @@
# 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.