From e05b05f67387eb5f230126cda85e8fa459b5a420 Mon Sep 17 00:00:00 2001 From: MarconLP <13001502+MarconLP@users.noreply.github.com> Date: Wed, 3 May 2023 20:14:09 +0200 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 126 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..43032b1 --- /dev/null +++ b/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 + + + + + + + + + + + + + + + + + + + + + + +
+ Type of Issue + + Priority +
+ Minor improvements, non-core feature requests + + + + +
+ Confusing UX (... but working) + + + + +
+ Core Features (Video upload) + + + + +
+ Core Bugs (Login, Video sharing, Recording are not working) + + + + +
+ +## 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. \ No newline at end of file diff --git a/README.md b/README.md index a603b0b..9b78a25 100644 --- a/README.md +++ b/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. \ No newline at end of file