From 1a29eb7f3369b625ad4f8868e58ab3f89ef253cd Mon Sep 17 00:00:00 2001 From: Ean Milligan Date: Tue, 21 May 2024 17:52:22 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..322b44d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# CONTRIBUTING TO GROUP UP +## Things to check before committing a change +- Formatting and linting + - Run `deno fmt` to set all formatting correct + - Run `deno lint` to check for any issues that need fixed +- Are you making a change that will be updating the version number? + - Update the version number in `README.md` and `config.example.ts`, and update the date in `README.md` + - Create a tag on your commit marking this version (name it Vx.x.x) +## Things to check after committing a change +- Check in on Sonar to see if your commit caused new issues to appear. If it did, please fix them