Contribution guidelines (#70)

* docs(github templates): added first draft of bug and feature issue templates

* docs(bug-report): added a field asking if the bug has been reported before

* docs(pull request): added a template for pull requests

* refactor(github templates): moved md templates to .github/ISSUE_TEMPLATES and changed to snake_case

this is the expected location and casing of these files

* docs(style_guide.md): first draft of style guide, could be less subjective and not as strict

* docs(*): added style guideline and contribution guideline

* fix(pull_request.md): fixed name, pull_request_template was expected instead of pull_request

* docs(*): made changes to the new markdown files based on feedback

* docs(contributing.md): added branchlint, npm script for branchlint, and updated contributing.md

contributing.md now includes info about branchlint and the step to run it

* docs(contributing.md): added a section covering contributing using a fork

* docs(style_guide.md): added a section for eslint and prettier extensions

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,9 +22,9 @@ What happens instead?
 ### Environment
 * Node version:
 * Device, operating system and its version:
-  -
+  *
 * Browser and its version:
-  -
+  *
 * Version of the affected apps and packages:
   *
 

CONTRIBUTING.md

@@ -66,10 +66,6 @@ pnpm branchlint
 
 2. Make your changes
 
-```bash
-pnpm changeset
-```
-
 3. Push a formatted commit
 
 Make sure to run this NPM script in the root of the monorepo and follow the CLI prompts.
@@ -91,4 +87,13 @@ Now that the changes are pushed to the remote branch, GitHub Actions will run wo
 
 When creating a pull request, make sure to follow the pull request template.
 
+## Contributing using a fork
 
+1. Head to the [repository](https://www.github.com/ballerine-io/ballerine).
+2. Click on the "Fork" button on the top right corner of the GitHub page.
+3. Create the fork.
+4. Follow the instructions from [prerequisites](#prerequisites) up to creating a pull request.
+5. On the compare page, click **compare across forks**.
+6. In the "base branch" drop-down menu, select the branch of the upstream repository you'd like to merge changes into.
+7. In the "head fork" drop-down menu, select your fork, then in the "compare branch" drop-down menu to select the branch you made your changes in.
+8. Create the pull request.

STYLE_GUIDE.md

@@ -4,6 +4,13 @@
 
 This repository makes use of EditorConfig, ESLint, and Prettier to enforce a consistent coding style. These tools are configured under `.editorconfig`, `packages/config/eslintrc.base.cjs`, and `packages/config/prettierrc.base.cjs` respectively. Linting can be done locally by running `pnpm lint:fix` and formatting by running `pnpm format` from the root of the monorepo.
 
+## Suggested editor extensions
+
+To avoid CI failing due to linting and formatting issues, it is recommended to install the following extensions for your editor and enable format/lint on save.
+
+* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+* [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
 ## General guidelines
 
 - Code indentation of 2 spaces.