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 or 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:

Fork this repository to your own GitHub account and then clone it to your local device.
Create a new branch:
```
git checkout -b MY_BRANCH_NAME
```
Install the dependencies with:
```
npm i
```
Start developing and watch for code changes:
```
npm run dev
```

Building

You can build the project with:

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:

npm run test:e2e

Linting

To check the formatting of your code:

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 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 .
Be sure to fill the PR Template accordingly.

3.5 KiB Raw Blame History