actions/setup-java
1
0
Fork 0
mirror of https://github.com/actions/setup-java synced 2024-09-19 22:35:18 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update contributors.md

Browse source
This commit is contained in:
Konrad Pabjan 2019-11-25 11:36:48 -05:00
parent 942699d9f7
commit e8e47f49d0
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/contributors.md
View file

@ -3,20 +3,32 @@
### Checkin ### Checkin
- Do checkin source (src) - Do checkin source (src)
- Do checkin build output (lib) - Do checkin a single index.js file after running `ncc`
- Do checkin runtime node_modules - Do not checking node_modules
- Do not checkin devDependency node_modules (husky can help see below)
### devDependencies ### NCC
In order to handle correctly checking in node_modules without devDependencies, we run [Husky](https://github.com/typicode/husky) before each commit. In order to avoid uploading `node_modules` to the repository, we use [zeit/ncc](https://github.com/zeit/ncc) to create a single `index.js` file that gets saved in `dist/`.
This step ensures that formatting and checkin rules are followed and that devDependencies are excluded. To make sure Husky runs correctly, please use the following workflow:
If you're developing locally you can run
``` ```
npm install # installs all devDependencies including Husky npm install
git add abc.ext # Add the files you've changed. This should include files in src, lib, and node_modules (see above) tsc
git commit -m "Informative commit message" # Commit. This will run Husky ncc build
```
You can also do
```
npm run-script build # runs tsc
npm run-script format # runs prettier --write
npm run-script format-check # runs prettier --check
npm run-script test # runs jest
npm run-script release # runs ncc build
``` ```
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier) as well as pruning out devDependencies using `npm prune --production`. Any files generated using `tsc` will be added to `lib/*`, however those files also are not uploaded to the repository and are excluded using `.gitignore`.
It will also make sure these changes are appropriately included in your commit (no further work is needed)
### Testing
Tests are included under `_tests_/*` and can be run using `npm run-script test`.
We ask that you include a link to a successful run that utilizes the changes you are working on. For example, if your changes are in the branch `newAwesomeFeature`, then show an example run that uses `setup-python@newAwesomeFeature` or `my-fork@newAwesomeFeature`. This will help speed up testing and help us confirm that there are no breaking changes or bugs.