setup-python/docs/contributors.md

Contributors

Checkin

• Do check in source (src/)
• Do check in a single index.js file after running ncc
• Do not check in node_modules/

NCC

In order to avoid uploading node_modules/ to the repository, we use zeit/ncc to create a single index.js file that gets saved in dist/.

Developing

If you're developing locally, you can run

npm install
tsc
ncc build src/setup-python.ts

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.

During the commit step, Husky will take care of formatting all files with Prettier (to run manually, use npm run format).

Testing

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.

Licensed

This repository uses a tool called Licensed to verify third party dependencies. You may need to locally install licensed and run licensed cache to update the dependency cache if you install or update a production dependency. If licensed cache is unable to determine the dependency, you may need to modify the cache file yourself to put the correct license. You should still verify the dependency, licensed is a tool to help, but is not a substitute for human review of dependencies.

Releases

There is a master branch where contributor changes are merged into. There are also release branches such as releases/v1 that are used for tagging (for example the v1 tag) and publishing new versions of the action. Changes from master are periodically merged into a releases branch. You do not need to create any PR that merges changes from master into a releases branch.