From 7272cc2caa468d3e009a2b0a9cc366839348237b Mon Sep 17 00:00:00 2001
From: Magnus Markling <magnus@markling.com>
Date: Thu, 25 Jul 2024 00:20:56 +0200
Subject: [PATCH] add CONTRIBUTING.md (#84)

---
 CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..73c8658
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing
+
+## General
+
+A good general description on how to develop a GitHub JavaScript action can be found [here](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action).
+
+## Developing locally
+
+### Prerequisites
+
+- Node 20
+
+### Installing dependencies
+
+`npm install`
+
+### Building the action
+
+`npm run build`
+
+Updates the contents of the `dist` folder, which then _needs to be committed_.
+
+### Formatting source files
+
+`npm run format`
+
+### Checking formatting of source files
+
+`npm run format-check`
+
+### Linting source files
+
+`npm run lint`
+
+### Running tests
+
+`npm run test`
+
+### Running all of the above sequentially
+
+`npm run all`
+
+## Adding a new input parameter
+
+The following places need to be updated
+
+- action.yml
+- src/main.ts (`getCheckReleaseArguments()`)
+- dist/index.js (automatically generated)
+- README.md