add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,126 @@
+# Contributing to Snapify
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+- Before jumping into a PR be sure to search [existing PRs](https://github.com/MarconLP/snapify/pulls) or [issues](https://github.com/MarconLP/snapify/issues) for an open or closed item that relates to your submission.
+
+## Priorities
+
+<table>
+  <tr>
+    <td>
+      Type of Issue
+    </td>
+    <td>
+      Priority
+    </td>
+  </tr>
+  <tr>
+    <td>
+      Minor improvements, non-core feature requests
+    </td>
+    <td>
+      <a href="https://github.com/MarconLP/snapify/issues?q=is:issue+is:open+sort:updated-desc+label:%22Low+priority%22">
+        <img src="https://img.shields.io/badge/-Low%20Priority-green">
+      </a>
+    </td>
+  </tr>
+   <tr>
+    <td>
+      Confusing UX (... but working)
+    </td>
+    <td>
+      <a href="https://github.com/MarconLP/snapify/issues?q=is:issue+is:open+sort:updated-desc+label:%22Medium+priority%22">
+        <img src="https://img.shields.io/badge/-Medium%20Priority-yellow">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      Core Features (Video upload)
+    </td>
+    <td>
+      <a href="https://github.com/MarconLP/snapify/issues?q=is:issue+is:open+sort:updated-desc+label:%22High+priority%22">
+        <img src="https://img.shields.io/badge/-High%20Priority-orange">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      Core Bugs (Login, Video sharing, Recording are not working)
+    </td>
+    <td>
+      <a href="https://github.com/MarconLP/snapify/issues?q=is:issue+is:open+sort:updated-desc+label:Urgent">
+        <img src="https://img.shields.io/badge/-Urgent-red">
+      </a>
+    </td>
+  </tr>
+</table>
+
+## Developing
+
+The development branch is `main`. This is the branch that all pull
+requests should be made against. The changes on the `main`
+branch are tagged into a release monthly.
+
+To develop locally:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
+   own GitHub account and then
+   [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
+2. Create a new branch:
+
+   ```sh
+   git checkout -b MY_BRANCH_NAME
+   ```
+
+3. Install the dependencies with:
+
+   ```sh
+   npm i
+   ```
+
+4. Start developing and watch for code changes:
+
+   ```sh
+   npm run dev
+   ```
+
+## Building
+
+You can build the project with:
+
+```bash
+npm run build
+```
+
+Please be sure that you can make a full production build before pushing code.
+
+## Testing
+
+More info on how to add new tests coming soon.
+
+### Running tests
+
+This will run and test all flows in multiple Chromium windows to verify that no critical flow breaks:
+
+```sh
+npm run test:e2e
+```
+
+## Linting
+
+To check the formatting of your code:
+
+```sh
+npm run lint
+```
+
+If you get errors, be sure to fix them before committing.
+
+## Making a Pull Request
+
+- Be sure to [check the "Allow edits from maintainers" option](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) while creating you PR.
+- If your PR refers to or fixes an issue, be sure to add `refs #XXX` or `fixes #XXX` to the PR description. Replacing `XXX` with the respective issue number. See more about [Linking a pull request to an issue
+  ](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+- Be sure to fill the PR Template accordingly.

README.md

@@ -68,7 +68,7 @@
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMarconLP%2Fsnapify)
 
 ## Contributing
-Please see our contributing guide at `CONTRIBUTION.md`
+Please see our contributing guide at `CONTRIBUTING.md`
 
 ## License
 Distributed under the Sustainable Use License. See `LICENSE.md` for more information.