diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d647ae91 --- /dev/null +++ b/CONTRIBUTING.md @@ -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/* +``` diff --git a/README.md b/README.md index ce29db74..226b9afd 100644 --- a/README.md +++ b/README.md @@ -73,33 +73,3 @@ jobs: deployment. A mabl journey is an end to end test of your application. - `journeys_failed` {int32} - number of mabl journeys that failed against this deployment. A mabl journey is an end to end test of your application. - -## Contributions and Issues - -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/* -```