Contributing to Plex Rewind

Any contributions are welcome and greatly appreciated!

Please follow the guidelines below.

Development

Git for source control
NodeJS (20.x or higher)
VSCode is highly recommended as an editor

Upon opening the project, a few extensions will be automatically recommended for install. These are highly recommended to install and will make development easier. You can find the list in .vscode/extensions.json.
pnpm as a package manager

Fork the repository to your own GitHub account and clone it to your local device:
```
git clone https://github.com/YOUR_USERNAME/plex-rewind.git
cd plex-rewind
```
Create .env.local file in the root of the project from the .env.example file:
```
cp .env.example .env.local
```
Install the project dependencies:
```
pnpm i
```
Create a new branch:
```
git checkout -b <YOUR_BRANCH_NAME> develop
```
You can read about how to name your branch under the code guidelines.
Run the development environment:
```
pnpm dev
```
Create your patch and test your changes. Be sure to follow the code guidelines.

Should you need to update your fork, you can do so by rebasing from upstream:

git fetch upstream
git rebase upstream/develop
git push origin BRANCH_NAME -f

If you are taking on an existing bug or feature ticket, please comment on the issue to avoid multiple people working on the same thing.
All commits must follow Conventional Commits rules.

Please make meaningful commits, or squash them prior to opening a pull request.
Do your best to check for spelling errors and grammatical mistakes.
Make sure to test your changes on different screen sizes to ensure responsiveness.
Do your research and follow the best practices for whatever tool or library you're using.
Use the appropriate Unicode characters for ellipses, arrows, and other special characters/symbols
Branch and PR naming should follow Conventional Commits logic.

Example branch name: feat(dashboard)/new-feature or fix/bug

Example pull request name: feat(dashboard): new feature or fix: bug
Make sure to keep your branch up-to-date.
Only open pull requests to develop, never main.

Any pull requests opened to main will be closed.