From 457e35645b52d7e9384125d97e7aed8ff012c143 Mon Sep 17 00:00:00 2001 From: Artur Michalek Date: Wed, 25 Oct 2023 13:33:26 +0200 Subject: [PATCH] Add simple contributing guide --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..db14243 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Building and Contributing Guide + +To contribute to this project, feel free to open a PR introducing your changes. + +Make sure that your PR is properly formatted. It can be automatically done with `npm run fmt`. + +Make sure that you've run `npm run build` command and committed any changes introduced in `dist` directory. +This step is necessary for your changes to actually be used in the action.