From 63b77fdf5ba646bda5804f686251fcd4617cd53c Mon Sep 17 00:00:00 2001 From: Matthew R Date: Sun, 3 May 2020 14:58:50 -0400 Subject: [PATCH] various changes to contributing guidelines --- CONTRIBUTING.md | 5 +++++ package.json | 3 +++ 2 files changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c41473a..14e178b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,3 +9,8 @@ We accept contributions from the community, however there's a few steps you need ## Issues If you're interested in tackling an issue, please comment on that particular issue that you're handling it so Maintainers can label it appropriately. + +## Other Information +* Make sure your contributions match the current style of the code, run `yarn run lint` to find issues with the style. Requests will be denied if they do not comply with styling. +* Submit your merge requests to the **dev** branch only. +* If you can use TypeScript functionality, do it. For example, don't declare something as `any` if it can be typed. diff --git a/package.json b/package.json index 31d1f91..09b59aa 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,9 @@ "version": "1.0.0", "description": "The official system for handling Community Relations in the LOC Discord server.", "main": "build/main.js", + "scripts": { + "lint": "eslint -c ./.eslintrc.json src --ext ts" + }, "repository": "https://gitlab.libraryofcode.org/engineering/communityrelations.git", "author": "Matthew R ", "license": "AGPL-3.0",