-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
break out contribution information into Contributing.md (#7)
- Loading branch information
Showing
2 changed files
with
27 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
If you would like to contribute, please submit a PR. If you encounter an | ||
problem, please file an Issue in this repo. | ||
|
||
### Making updates | ||
|
||
Actions need the compiled code checked in. This means your changes will only | ||
take effect if you run the build to generate .js files from the .ts Typescript | ||
files and check the .js files in as well. | ||
|
||
### Adding new dependencies | ||
|
||
Check in the Action with everything it needs to run. If you update dependencies | ||
you will need to commit the changes to Node modules as well. | ||
|
||
```bash | ||
# Remove any non-production dependencies | ||
npm prune --production | ||
|
||
# Compile Typescript to ES6 | ||
npm run build | ||
|
||
# Add the compiled Typescript output | ||
git add lib/ | ||
|
||
# Add Node dependencies | ||
git add -f node_modules/* | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters