Merge pull request #13 from per1234/dev-docs

Move development documentation to CONTRIBUTING.md

Author: per1234

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+## Development
+
+To work on the codebase you have to install all the dependencies:
+
+```sh
+# npm install
+```
+
+To run the tests:
+
+```sh
+# npm run test
+```
+
+## Enable verbose logging for a pipeline
+Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
+
+See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
+
+## Release
+
+To release a new version of the Action the workflow should be the following:
+
+1. `npm install` to install the dependencies.
+1. `npm run test` to see everything works as expected.
+1. `npm run build` to build the Action under the `./lib` folder.
+1. `npm run pack` to package for distribution
+1. `git add src dist` to check in the code that matters.
+1. open a PR and request a review.

README.md

@@ -57,33 +57,3 @@ If you think you found a vulnerability or other security-related bug in this pro
 Thank you!
 
 e-mail contact: [email protected]
-
-## Development
-
-To work on the codebase you have to install all the dependencies:
-
-```sh
-# npm install
-```
-
-To run the tests:
-
-```sh
-# npm run test
-```
-
-## Enable verbose logging for a pipeline
-Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
-
-See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
-
-## Release
-
-To release a new version of the Action the workflow should be the following:
-
-1. `npm install` to install the dependencies.
-1. `npm run test` to see everything works as expected.
-1. `npm run build` to build the Action under the `./lib` folder.
-1. `npm run pack` to package for distribution
-1. `git add src dist` to check in the code that matters.
-1. open a PR and request a review.