setup-python/docs/contributors.md

28 lines
1.0 KiB
Markdown
Raw Normal View History

2019-08-20 22:27:52 +08:00
# Contributors
### Checkin
- Do checkin source (src)
2019-11-08 04:26:27 +08:00
- Do checkin a single index.js file after running `ncc`
- Do not checkin node_modules
2019-08-20 22:27:52 +08:00
2019-11-08 04:26:27 +08:00
### NCC
2019-08-20 22:27:52 +08:00
2019-11-08 04:26:27 +08: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-08-20 22:27:52 +08:00
2019-11-08 04:26:27 +08:00
### Developing
If you're developing locally you can run
2019-08-20 22:27:52 +08:00
```
2019-11-08 04:26:27 +08:00
npm install
tsc
ncc build
2019-08-20 22:27:52 +08:00
```
2019-11-25 21:46:36 +08:00
Any files generated using `tsc` will be added to `lib/*`, however those files also are not uploaded to the repository and are exluded using `.gitignore`.
2019-11-08 04:26:27 +08:00
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier)
### Testing
2019-08-20 22:27:52 +08:00
2019-11-25 21:46:36 +08:00
We ask that you include a link to a succesfull 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.