chore: contribution readme and eslint alignment (#356)

* contribution file and eslint alignment

* Specifying environments fix

* eslint addons

* eslint addons fix

* eslint addons f

* final fixes after investigation

.eslintrc

@@ -1,17 +1,15 @@
 {
   "root": true,
+  "env": {
+    "node": true,
+    "es2021": true
+  },
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2019,
     "project": ["./tsconfig.json"]
   },
-  "plugins": [
-    "@typescript-eslint",
-    "unicorn",
-    "promise",
-    "prettier",
-    "jest"
-  ],
+  "plugins": ["@typescript-eslint", "unicorn", "promise", "prettier", "jest"],
   "extends": [
     "eslint:recommended",
     "plugin:node/recommended",
@@ -20,9 +18,10 @@
     "plugin:import/warnings",
     "plugin:import/typescript",
     "plugin:unicorn/recommended",
-    "plugin:prettier/recommended",
     "plugin:promise/recommended",
-    "plugin:jest/style"
+    "plugin:jest/style",
+    "plugin:eslint-comments/recommended",
+    "plugin:prettier/recommended"
   ],
   "rules": {
     "no-process-exit": "off",
@@ -43,7 +42,10 @@
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-non-null-assertion": "off"
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "eslint-comments/require-description": ["error", { "ignore": [] }],
+    "@typescript-eslint/no-unused-vars": "warn",
+    "@typescript-eslint/no-floating-promises": ["warn", { "ignoreVoid": true }]
   },
   "overrides": [
     {

.gitignore

@@ -5,10 +5,15 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
+# dependencies
 node_modules/
+
 *.tsbuildinfo
 .yarn-integrity
 .docker
-
+/coverage
 
 services/tests/blackbox/resources
+
+# compiled output
+/dist

.prettierrc

@@ -1,5 +1,6 @@
 {
   "printWidth": 120,
   "singleQuote": true,
-  "arrowParens": "avoid"
+  "arrowParens": "avoid",
+  "bracketSpacing": true
 }

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
-    // List of extensions which should be recommended for users of this workspace.
-    "recommendations": ["esbenp.prettier-vscode", "kumar-harsh.graphql-for-vscode"],
-    // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
-    "unwantedRecommendations": []
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": ["esbenp.prettier-vscode", "kumar-harsh.graphql-for-vscode", "dbaeumer.vscode-eslint"],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
 }

.vscode/settings.json

@@ -1,3 +1,9 @@
 {
-    "debug.node.autoAttach": "on"
+  "debug.node.autoAttach": "on",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "eslint.onIgnoredFiles": "warn",
+  "eslint.options": {
+    "ignorePath": ".gitignore",
+    "extensions": [".js", ".ts"]
+  }
 }

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to Stitch
+
+Welcome, and thank you for your interest in contributing to Stitch!
+
+There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
+
+## Asking Questions
+
+Have a question? Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/) using the a related tag
+
+The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.
+
+## Providing Feedback
+
+Your comments and feedback are welcome, and the development team is available via a handful of different channels:
+
+- GitHub issues
+- Any related slack channels or stackoverflow
+
+## Reporting Issues
+
+Have you identified a reproducible problem in Stitch? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
+
+### Look For an Existing Issue
+
+Before you create a new issue, please do a search in [open issues](https://github.com/Soluto/stitch/issues) to see if the issue or feature request has already been filed.
+
+If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
+
+### Writing Good Bug Reports and Feature Requests
+
+File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
+
+Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.
+
+The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
+
+Please include the following with each issue:
+
+- Version of Stitch
+- Your operating system
+- Reproducible steps (1... 2... 3...) that cause the issue
+- What you expected to see, versus what you actually saw
+- Images, animations, or a link to a video showing the issue occurring
+- A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
+  - **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
+
+### Final Checklist
+
+Please remember to do the following:
+
+- [ ] Search the issue repository to ensure your report is a new issue
+- [ ] Simplify your code around the issue to better isolate the problem
+
+Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!
+
+## Contributing Fixes
+
+There are many ways to contribute to the Stitch project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
+
+After cloning and building the repo, check out the issues list. Issues labeled `help wanted` are good issues to submit a PR for. Issues labeled `good first issue` are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, or if the issue is already assigned to a specific month milestone, please discuss with the issue assignee first before starting to work on the issue
+
+# Thank You!
+
+Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

package.json

@@ -19,6 +19,7 @@
     "@typescript-eslint/parser": "^4.22.0",
     "eslint": "^7.24.0",
     "eslint-config-prettier": "^8.2.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.3.5",
     "eslint-plugin-node": "^11.1.0",