setup-java/docs/contributors.md

34 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2019-07-10 14:54:25 +00:00
# Contributors
### Checkin
- Do checkin source (src)
2019-11-25 16:36:48 +00:00
- Do checkin a single index.js file after running `ncc`
- Do not checking node_modules
2019-07-10 14:54:25 +00:00
2019-11-25 16:36:48 +00:00
### NCC
2019-07-10 14:54:25 +00:00
2019-11-25 16:36:48 +00:00
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/`.
2019-07-10 14:54:25 +00:00
2019-11-25 16:36:48 +00:00
If you're developing locally you can run
2019-07-10 14:54:25 +00:00
```
2019-11-25 16:36:48 +00:00
npm install
tsc
ncc build
2019-07-10 14:54:25 +00:00
```
2019-11-25 16:36:48 +00:00
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
```
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`.
### Testing
Tests are included under `_tests_/*` and can be run using `npm run-script test`.
2019-07-10 14:54:25 +00:00
2019-11-25 16:36:48 +00:00
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.