Create CONTRIBUTING.md

This commit is contained in:
Ean Milligan 2024-05-21 17:52:22 -04:00 committed by GitHub
parent 0b8ae5c4e7
commit 1a29eb7f33
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions

10
CONTRIBUTING.md Normal file
View File

@ -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