From d19f0cf305445ca572d5684e14c2d80418b6cbe0 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Fri, 16 Jun 2023 21:08:54 +0100 Subject: [PATCH 01/29] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..412c4af2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +codeofconduct@movie-web.app. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From 969aa6156ebf0100a0fc32671691eb988075d15c Mon Sep 17 00:00:00 2001 From: William Oldham Date: Fri, 16 Jun 2023 21:26:49 +0100 Subject: [PATCH 02/29] Create SECURITY.md --- SECURITY.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..83bf16ae --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +## Supported Versions + +The movie-web maintainers only support the latest version of movie-web published at https://movie-web.app. + +Support is not provided for any forks or mirrors of movie-web. + +## Reporting a Vulnerability + +There are two ways you can contact the movie-web maintainers to report a vulnerability: + - Email [security@movie-web.app](mailto:security@movie-web.app) + - Report the vulnerability in the [movie-web Discord server](https://discord.movie-web.app) From 102d252f8259eaa71e9ca9db4c424d887c648de5 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 Jun 2023 20:57:34 +0100 Subject: [PATCH 03/29] Move code of conduct and security police into .github folder --- CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md | 0 SECURITY.md => .github/SECURITY.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (100%) rename SECURITY.md => .github/SECURITY.md (100%) diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/SECURITY.md b/.github/SECURITY.md similarity index 100% rename from SECURITY.md rename to .github/SECURITY.md From 5c50155718d820f5ec7f145b410853b53141906c Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 Jun 2023 20:57:50 +0100 Subject: [PATCH 04/29] Update Discord invite to discord.movie-web.app --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aaaa12cb..8bde28ed 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ GitHub license GitHub forks GitHub stars
-Discord Server +Discord Server

movie-web is a web app for watching movies easily. Check it out at **[movie-web.app](https://movie-web.app)**. From 81b22b04739311f5f80604e972daa24217c40c9c Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 Jun 2023 20:59:06 +0100 Subject: [PATCH 05/29] Add "awaiting-approval" label to issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index d62b8c1b..3bf7111e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: Bug Report description: File a bug report title: "[Bug]: " -labels: ["bug"] +labels: ["bug", "awaiting-approval"] assignees: [] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 2c9f9a77..c20238db 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ -name: Feature request +name: Feature Request description: Suggest a new feature title: "[Feature]: " -labels: ["enhancement"] +labels: ["feature", "awaiting-approval"] assignees: [] body: - type: textarea From 03d414a2007866736f0f6dec523f106a74e3d393 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 Jun 2023 21:00:20 +0100 Subject: [PATCH 06/29] Add initial content to contributing guidelines --- .github/CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..b82b11d0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing Guidelines for movie-web + +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [movie-web.app](https://movie-web.app)! + +Please make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. + +## New contributor guide + +To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: + +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) + +## Before you start! +Before starting a contribution, please make your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). + +GitHub issues are how we track our bugs and feature requests that will be implemented into movie-web - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on. + +> :warning: The exception to this are language contributions, which are discussed in [this section](#language-contributions) + +Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue it means your work will have gone to waste! + +## Requesting a feature or reporting an bug +There are two places where to request features or report bugs: + - GitHub Issues + - The movie-web Discord server + +### Discord Server +If you do not have a GitHub account, or would like to discuss a feature or bug with us before making an issue, you can join our Discord server! + +Discord Server + +### GitHub Issues +To make a GitHub issue for movie-web, please visit the [new issue page](https://github.com/movie-web/movie-web/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template. + +When filling out an issue template, please make sure to include as much detail as possible and include any screenshots or console logs as appropriate. From a9a3eac4eaa3899ef2d9b955dd871bcc9ef1513f Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sat, 24 Jun 2023 21:52:16 +0100 Subject: [PATCH 07/29] Add contributing, dev env and tips section to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 47 ++++++++++++++++++++++++++++++++++------- 1 file changed, 39 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b82b11d0..7ce753e1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,14 +13,6 @@ To get an overview of the project, read the [README](README.md). Here are some r - [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) -## Before you start! -Before starting a contribution, please make your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). - -GitHub issues are how we track our bugs and feature requests that will be implemented into movie-web - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on. - -> :warning: The exception to this are language contributions, which are discussed in [this section](#language-contributions) - -Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue it means your work will have gone to waste! ## Requesting a feature or reporting an bug There are two places where to request features or report bugs: @@ -36,3 +28,42 @@ If you do not have a GitHub account, or would like to discuss a feature or bug w To make a GitHub issue for movie-web, please visit the [new issue page](https://github.com/movie-web/movie-web/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template. When filling out an issue template, please make sure to include as much detail as possible and include any screenshots or console logs as appropriate. + +After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will assign the https://github.com/movie-web/movie-web/labels/planned label. + +## Before you start! +Before starting a contribution, please make your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). + +GitHub issues are how we track our bugs and feature requests that will be implemented into movie-web - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on. + +If a pull-request is opened before an issue is created and accepted, you may be at risk of having your pull request rejected! Always check with us before starting work on a feature - we don't want to waste your time! + +> **Note** +> The exception to this are language contributions, which are discussed in [this section](#language-contributions) + +Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue it means your work will have gone to waste! + +## Contributing +If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to movie-web, it means a lot :heart: + +Firstly, make sure you've read the [Before you start!](#before-you-start) section! + +When you have found a GitHub issue you would like to work on, you can request to be assigned to the issue by commenting on the GitHub issue. + +If you are assigned to an issue but for whatever reason can't complete it, no problem! Just let us know and we will open up the issue to have someone else assigned. + +### Recommended Development Environment +Our recommended development environment to work on movie-web is: +- [Visual Studio Code](https://code.visualstudio.com/) +- [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + +Our project is setup to enforce formatting and code style standards using ESLint. + +### Tips +Here are some tips to make sure that your pull requests are :pinched_fingers: first time! + +- KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code! +- Follow standard best practices for TypeScript and React. +- Keep as much as possible to the style of movie-web. Have a look round our codebase to familiarise yourself with how we do things! +- Make sure to take note of the ESLint errors and warnings! **Do not ignore them!** They are there for a reason. +- Test, test, test! Make sure you fully test the features you are contributing. From 81f0425755d09f4a3c47c20c86eeefa1ca1fec07 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sun, 25 Jun 2023 18:29:50 +0100 Subject: [PATCH 08/29] Apply suggestions from code review Co-authored-by: James Hawkins --- .github/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7ce753e1..d38c42c3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Guidelines for movie-web -Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [movie-web.app](https://movie-web.app)! +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [movie-web.app](https://movie-web.app). Please make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. @@ -20,7 +20,7 @@ There are two places where to request features or report bugs: - The movie-web Discord server ### Discord Server -If you do not have a GitHub account, or would like to discuss a feature or bug with us before making an issue, you can join our Discord server! +If you do not have a GitHub account, or would like to discuss a feature or bug with us before making an issue, you can join our Discord server. Discord Server @@ -60,7 +60,7 @@ Our recommended development environment to work on movie-web is: Our project is setup to enforce formatting and code style standards using ESLint. ### Tips -Here are some tips to make sure that your pull requests are :pinched_fingers: first time! +Here are some tips to make sure that your pull requests are :pinched_fingers: first time: - KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code! - Follow standard best practices for TypeScript and React. From 9b852f12cfc0f9c5bcb8b4d5e9215e12f00710f8 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sun, 2 Jul 2023 16:54:49 +0100 Subject: [PATCH 09/29] doc(selfhosting): tweak text for grammar and add links to common services --- SELFHOSTING.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/SELFHOSTING.md b/SELFHOSTING.md index 7137be1f..7789a5df 100644 --- a/SELFHOSTING.md +++ b/SELFHOSTING.md @@ -1,38 +1,40 @@ -# Selfhosting tutorial +# Self-hosting tutorial -> **Note:** We do not provide support on how to selfhost, if you cant figure it out then tough luck. Please do not make Github issues or ask in our Discord server for support on how to selfhost. +> **Note** +> We do not provide support on how to self-host, if you cant figure it out then tough luck. Please do not make GitHub issues or ask in our Discord server for support on how to self-host. -So you wanna selfhost. This app is made of two parts: +So you would like to self-host. This app is made of two parts: - The proxy - The client ## Hosting the proxy -The proxy is made as a cloudflare worker, cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users. +The proxy is made as a Cloudflare worker. Cloudflare has a generous free plan, so you don't need to pay anything unless you get hundreds of users. -1. Create a cloudflare account at [https://dash.cloudflare.com](https://dash.cloudflare.com) +1. Create a Cloudflare account at [https://dash.cloudflare.com](https://dash.cloudflare.com). 2. Navigate to `Workers`. -3. If it asks you, choose a subdomain -4. If it asks for a workers plan, press "Continue with free" -5. Create a new service with a name of your choice. Must be type `HTTP handler` -6. On the service page, Click `Quick edit` -7. Download the `worker.js` file from the latest release of the proxy: [https://github.com/movie-web/simple-proxy/releases/latest](https://github.com/movie-web/simple-proxy/releases/latest) -8. Open the downloaded `worker.js` file in notepad, VScode or similar. +3. If it asks you, choose a subdomain. +4. If it asks for a workers plan, press "Continue with free". +5. Create a new service with a name of your choice. Must be type `HTTP handler`. +6. On the service page, Click `Quick edit`. +7. Remove the template code in the quick edit window. +7. Download the `worker.js` file from the latest release of the proxy: [https://github.com/movie-web/simple-proxy/releases/latest](https://github.com/movie-web/simple-proxy/releases/latest). +8. Open the downloaded `worker.js` file in Notepad, Visual Studio Code or similar. 9. Copy the text contents of the `worker.js` file. -10. Paste the text contents into the edit screen of the cloudflare service worker. +10. Paste the text contents into the edit screen of the Cloudflare service worker. 11. Click `Save and deploy` and confirm. -Your proxy is now hosted on cloudflare. Note the url of your worker. you will need it later. +Your proxy is now hosted on Cloudflare. Note the url of your worker as you will need it later. ## Hosting the client -1. Download the file `movie-web.zip` from the latest release: [https://github.com/movie-web/movie-web/releases/latest](https://github.com/movie-web/movie-web/releases/latest) +1. Download the file `movie-web.zip` from the latest release: [https://github.com/movie-web/movie-web/releases/latest](https://github.com/movie-web/movie-web/releases/latest). 2. Extract the zip file so you can edit the files. -3. Open `config.js` in notepad, VScode or similar. -4. Put your cloudflare proxy URL inbetween the double qoutes of `VITE_CORS_PROXY_URL: "",`. Make sure to not have a slash at the end of your URL. +3. Open `config.js` in Notepad, Visual Studio Code or similar. +4. Put your Cloudflare proxy URL in-between the double quotes of `VITE_CORS_PROXY_URL: "",`. Make sure to not have a slash at the end of your URL. Example (THIS IS MINE, IT WONT WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev",` -5. Save the file +5. Save the file. -Your client has been prepared, you can now host it on any webhost. -It doesn't require php, its just a standard static page. +Your client has now been prepared, you can now host it with any static website hosting (Common ones include [GitHub Pages](https://pages.github.com/), [Netlify](https://www.netlify.com/) and [Vercel](https://vercel.com/) but any will work!). +It doesn't require PHP, it's just a standard static page. From 8b1a5bce4a3e85da2471be7cf0ab1480a9338843 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sun, 2 Jul 2023 16:56:20 +0100 Subject: [PATCH 10/29] doc(selfhosting): emphasis DO NOT and fix further grammar --- SELFHOSTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SELFHOSTING.md b/SELFHOSTING.md index 7789a5df..7e7fc0f3 100644 --- a/SELFHOSTING.md +++ b/SELFHOSTING.md @@ -1,7 +1,7 @@ # Self-hosting tutorial > **Note** -> We do not provide support on how to self-host, if you cant figure it out then tough luck. Please do not make GitHub issues or ask in our Discord server for support on how to self-host. +> We **do not** provide support on how to self-host. If you can't figure it out then tough luck. Please do not make GitHub issues or ask in our Discord server for support on how to self-host. So you would like to self-host. This app is made of two parts: - The proxy From 8d0cd59d8580425ef768dcbc60167cea9f0cf684 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sun, 2 Jul 2023 23:26:02 +0100 Subject: [PATCH 11/29] docs(contributing): Add a contents sections --- .github/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d38c42c3..aa4b1162 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,6 +4,17 @@ Thank you for investing your time in contributing to our project! Any contributi Please make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. +## Contents + - [New Contributor Guide](#new-contributor-guide) + - [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-an-bug) + - [Discord Server](#discord-server) + - [GitHub Issues](#github-issues) + - [Before you start](#before-you-start) + - [Contributing](#before-you-start) + - [Recommended Development Environment](#recommended-development-environment) + - [Tips](#tips) + - [Language Contributions](#language-contributions) + ## New contributor guide To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: From 76a12b8f7af041df9b79243ac9040ef1c9d119b5 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Sun, 2 Jul 2023 23:26:17 +0100 Subject: [PATCH 12/29] docs(contributing): add start of language contributions --- .github/CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index aa4b1162..cc00fd41 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -78,3 +78,10 @@ Here are some tips to make sure that your pull requests are :pinched_fingers: fi - Keep as much as possible to the style of movie-web. Have a look round our codebase to familiarise yourself with how we do things! - Make sure to take note of the ESLint errors and warnings! **Do not ignore them!** They are there for a reason. - Test, test, test! Make sure you fully test the features you are contributing. + +### Language Contributions +Language contritions help movie-web massively allowing people from all across the world to use our app! + +Like most apps, our translations are stored in `.json` files. Each language string has a unique key (For example, `notFound.genericTitle`) which references a language string in the appropriate language file. + +Each language file is called `translation.json` and are stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. From bc3848fae40821eaac6a4dfbca05170fc306630c Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 10:31:39 +0100 Subject: [PATCH 13/29] docs(contributing): Add the meat of the language contribution section --- .github/CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cc00fd41..caffcb11 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -85,3 +85,24 @@ Language contritions help movie-web massively allowing people from all across th Like most apps, our translations are stored in `.json` files. Each language string has a unique key (For example, `notFound.genericTitle`) which references a language string in the appropriate language file. Each language file is called `translation.json` and are stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. + +> **Warning** +> Before you start a translation, please check: +> - That there isn't an existing GitHub issue or pull request open for that language. +> - That we aren't in the middle of a new feature update! When releasing major versions, we don't accept language until the new version is complete otherwise the language files would be outdated. +> +> Please speak to us before starting a language PR. We don't want to waste your time. + +To make a translation: + - Copy the `en` folder inside the `src/setup/languages` folder + - Rename the copied folder to the 2 letter code for the country/language you are translating to. + - [Click this link to see a list of codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Make sure to use the codes in the `639-1` column! + - For example, Arabic is `ar` + - Edit the language strings inside the `translation.json` file + - **Do not** edit the keys, only edit the values. + - e.g. in `"stopEditing": "Stop editing",` - only change the `Stop editing` part, not the `stopEditing` part. + - In the `src/setup/i18n.ts` file: + - Import your new translation file, e.g. `import ar from "./locales/ar/translation.json";` + - Add your translation to the `locales` object (Look at other languages for an example) + +Once you have made your translation, please open a pull request. We do not accept partial translations so please make sure every language string is translated to the intended language. From b1663a919f875c55e5c822ce30808d1016bafa14 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 10:34:39 +0100 Subject: [PATCH 14/29] docs(contributing): add links and tweak text of language guidelines --- .github/CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index caffcb11..26ec5c59 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -87,9 +87,10 @@ Like most apps, our translations are stored in `.json` files. Each language stri Each language file is called `translation.json` and are stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. > **Warning** +> > Before you start a translation, please check: -> - That there isn't an existing GitHub issue or pull request open for that language. -> - That we aren't in the middle of a new feature update! When releasing major versions, we don't accept language until the new version is complete otherwise the language files would be outdated. +> - That there isn't an existing GitHub [issue](https://github.com/movie-web/movie-web/issues) or [pull request](https://github.com/movie-web/movie-web/pulls) open for the language. +> - That we aren't in the middle of a new feature update. When releasing major versions, we don't accept language until the new version is complete otherwise the language files would be outdated. > > Please speak to us before starting a language PR. We don't want to waste your time. From 8d82ee5f88a756492a0afd394bbe943051fb9e94 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 17:52:09 +0100 Subject: [PATCH 15/29] docs(contributing): proof reading pass --- .github/CONTRIBUTING.md | 57 ++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 26ec5c59..e709549d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing Guidelines for movie-web -Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [movie-web.app](https://movie-web.app). +Thank you for investing your time in contributing to our project! Your contribution will be reflected on [movie-web.app](https://movie-web.app). -Please make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. +Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. ## Contents - [New Contributor Guide](#new-contributor-guide) @@ -17,93 +17,92 @@ Please make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep ou ## New contributor guide -To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: +To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open-source contributions: -- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Finding ways to contribute to open-source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) - [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) - [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) -## Requesting a feature or reporting an bug +## Requesting a feature or reporting a bug There are two places where to request features or report bugs: - GitHub Issues - The movie-web Discord server ### Discord Server -If you do not have a GitHub account, or would like to discuss a feature or bug with us before making an issue, you can join our Discord server. +If you do not have a GitHub account or want to discuss a feature or bug with us before making an issue, you can join our Discord server. Discord Server ### GitHub Issues To make a GitHub issue for movie-web, please visit the [new issue page](https://github.com/movie-web/movie-web/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template. -When filling out an issue template, please make sure to include as much detail as possible and include any screenshots or console logs as appropriate. +When filling out an issue template, please include as much detail as possible and any screenshots or console logs as appropriate. -After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will assign the https://github.com/movie-web/movie-web/labels/planned label. +After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will set the https://github.com/movie-web/movie-web/labels/planned label. ## Before you start! -Before starting a contribution, please make your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). +Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). GitHub issues are how we track our bugs and feature requests that will be implemented into movie-web - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on. -If a pull-request is opened before an issue is created and accepted, you may be at risk of having your pull request rejected! Always check with us before starting work on a feature - we don't want to waste your time! +If a pull request is opened before an issue is created and accepted, you may risk having your pull request rejected! Always check with us before starting work on a feature - we don't want to waste your time! > **Note** > The exception to this are language contributions, which are discussed in [this section](#language-contributions) -Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue it means your work will have gone to waste! +Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste! ## Contributing -If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to movie-web, it means a lot :heart: +If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to movie-web; it means a lot :heart: Firstly, make sure you've read the [Before you start!](#before-you-start) section! When you have found a GitHub issue you would like to work on, you can request to be assigned to the issue by commenting on the GitHub issue. -If you are assigned to an issue but for whatever reason can't complete it, no problem! Just let us know and we will open up the issue to have someone else assigned. +If you are assigned to an issue but can't complete it for whatever reason, no problem! Just let us know, and we will open up the issue to have someone else assigned. ### Recommended Development Environment Our recommended development environment to work on movie-web is: - [Visual Studio Code](https://code.visualstudio.com/) - [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) -Our project is setup to enforce formatting and code style standards using ESLint. +Our project is set up to enforce formatting and code style standards using ESLint. ### Tips Here are some tips to make sure that your pull requests are :pinched_fingers: first time: - KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code! - Follow standard best practices for TypeScript and React. -- Keep as much as possible to the style of movie-web. Have a look round our codebase to familiarise yourself with how we do things! -- Make sure to take note of the ESLint errors and warnings! **Do not ignore them!** They are there for a reason. -- Test, test, test! Make sure you fully test the features you are contributing. +- Keep as much as possible to the style of movie-web. Look around our codebase to familiarise yourself with how we do things! +- Ensure to take note of the ESLint errors and warnings! **Do not ignore them!** They are there for a reason. +- Test, test, test! Make sure you thoroughly test the features you are contributing. ### Language Contributions -Language contritions help movie-web massively allowing people from all across the world to use our app! +Language contributions help movie-web massively, allowing people worldwide to use our app! -Like most apps, our translations are stored in `.json` files. Each language string has a unique key (For example, `notFound.genericTitle`) which references a language string in the appropriate language file. +Like most apps, our translations are stored in `.json` files. Each language string has a unique key (For example, `notFound.genericTitle`) that references a language string in the appropriate language file. -Each language file is called `translation.json` and are stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. +Each language file is called `translation.json` and is stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. > **Warning** +> Before you start a translation, please: +> - Check there isn't an existing GitHub [issue](https://github.com/movie-web/movie-web/issues) or [pull request](https://github.com/movie-web/movie-web/pulls) open for the language. +> - Make sure we aren't in the middle of a new feature update. When releasing major versions, we only accept language once the new version is complete. Otherwise, the language files would need to be updated. > -> Before you start a translation, please check: -> - That there isn't an existing GitHub [issue](https://github.com/movie-web/movie-web/issues) or [pull request](https://github.com/movie-web/movie-web/pulls) open for the language. -> - That we aren't in the middle of a new feature update. When releasing major versions, we don't accept language until the new version is complete otherwise the language files would be outdated. -> -> Please speak to us before starting a language PR. We don't want to waste your time. +> Please speak to us before starting a language PR. We want to use your time effectively. To make a translation: - Copy the `en` folder inside the `src/setup/languages` folder - - Rename the copied folder to the 2 letter code for the country/language you are translating to. - - [Click this link to see a list of codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Make sure to use the codes in the `639-1` column! + - Rename the copied folder to the 2-letter code for the country/language which is being translated. + - [Click this link to see a list of codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Use the codes in the `639-1` column! - For example, Arabic is `ar` - Edit the language strings inside the `translation.json` file - - **Do not** edit the keys, only edit the values. + - **Do not** edit the keys. Only edit the values. - e.g. in `"stopEditing": "Stop editing",` - only change the `Stop editing` part, not the `stopEditing` part. - In the `src/setup/i18n.ts` file: - Import your new translation file, e.g. `import ar from "./locales/ar/translation.json";` - Add your translation to the `locales` object (Look at other languages for an example) -Once you have made your translation, please open a pull request. We do not accept partial translations so please make sure every language string is translated to the intended language. +Once you have completed your translation, please open a pull request. We do not accept partial translations, so please ensure every language string is translated to the intended language. From ce71a2d63895df6cf483d7d3bc8ebb99de7339aa Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:07:45 +0100 Subject: [PATCH 16/29] docs(selfhosting): match update with dev branch --- SELFHOSTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SELFHOSTING.md b/SELFHOSTING.md index c9598559..1d5bc602 100644 --- a/SELFHOSTING.md +++ b/SELFHOSTING.md @@ -33,7 +33,7 @@ Your proxy is now hosted on Cloudflare. Note the url of your worker as you will 3. Open `config.js` in Notepad, Visual Studio Code or similar. 4. Put your Cloudflare proxy URL in-between the double quotes of `VITE_CORS_PROXY_URL: ""`. Make sure to not have a slash at the end of your URL. - Example (THIS IS MINE, IT WONT WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev",` + Example (THIS IS MINE, IT WONT WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"` 5. Put your TMDB read access token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. You can generate it for free at [https://www.themoviedb.org/settings/api](https://www.themoviedb.org/settings/api). 6. Save the file From 91f9f56174a7b265e9bd1bdaa9d3c19235b25517 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:08:03 +0100 Subject: [PATCH 17/29] doc: use discord.com instead of discordapp.com --- .github/CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e709549d..cd3dbf65 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -33,7 +33,7 @@ There are two places where to request features or report bugs: ### Discord Server If you do not have a GitHub account or want to discuss a feature or bug with us before making an issue, you can join our Discord server. -Discord Server +Discord Server ### GitHub Issues To make a GitHub issue for movie-web, please visit the [new issue page](https://github.com/movie-web/movie-web/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template. diff --git a/README.md b/README.md index 8bde28ed..d613badb 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ GitHub license GitHub forks GitHub stars
-Discord Server +Discord Server

movie-web is a web app for watching movies easily. Check it out at **[movie-web.app](https://movie-web.app)**. From 6705683c191c75b392a61557fc363841ec8bb7f5 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:14:17 +0100 Subject: [PATCH 18/29] doc(selfhosting): update example message to be more clear Co-authored-by: Jip Fr --- SELFHOSTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SELFHOSTING.md b/SELFHOSTING.md index 1d5bc602..e27a102d 100644 --- a/SELFHOSTING.md +++ b/SELFHOSTING.md @@ -33,7 +33,7 @@ Your proxy is now hosted on Cloudflare. Note the url of your worker as you will 3. Open `config.js` in Notepad, Visual Studio Code or similar. 4. Put your Cloudflare proxy URL in-between the double quotes of `VITE_CORS_PROXY_URL: ""`. Make sure to not have a slash at the end of your URL. - Example (THIS IS MINE, IT WONT WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"` + Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"` 5. Put your TMDB read access token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. You can generate it for free at [https://www.themoviedb.org/settings/api](https://www.themoviedb.org/settings/api). 6. Save the file From 0c18d8f04b47753c6d7004606e00fcfe2a31cde1 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:29:56 +0100 Subject: [PATCH 19/29] docs(contributing): add note about editorconfig ext and vsc auto install --- .github/CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cd3dbf65..e81989bc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -67,6 +67,9 @@ If you are assigned to an issue but can't complete it for whatever reason, no pr Our recommended development environment to work on movie-web is: - [Visual Studio Code](https://code.visualstudio.com/) - [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [EditorConfig Extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) + +When opening Visual Studio Code, you will be prompted to install our recommended extensions if they are not installed for you. Our project is set up to enforce formatting and code style standards using ESLint. From 6a926ec7fe95679829a7d6e0d3cfe848ddadc21d Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:30:28 +0100 Subject: [PATCH 20/29] docs(contributing): reword note to be based off the planned label rather than awaiting approval --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e81989bc..8c1cb182 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -52,7 +52,7 @@ If a pull request is opened before an issue is created and accepted, you may ris > **Note** > The exception to this are language contributions, which are discussed in [this section](#language-contributions) -Also, make sure that the issue you would like to work on has not been got the "awaiting-approval" label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste! +Also, make sure that the issue you would like to work on has been given the https://github.com/movie-web/movie-web/labels/planned label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste! ## Contributing If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to movie-web; it means a lot :heart: From 3cdb056d43cc24bd718b1f025f77ef15390d26aa Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 18:39:31 +0100 Subject: [PATCH 21/29] docs(contributing): fix grammar error in language contributions --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8c1cb182..bc6ae37b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -92,7 +92,7 @@ Each language file is called `translation.json` and is stored in the `src/setup/ > **Warning** > Before you start a translation, please: > - Check there isn't an existing GitHub [issue](https://github.com/movie-web/movie-web/issues) or [pull request](https://github.com/movie-web/movie-web/pulls) open for the language. -> - Make sure we aren't in the middle of a new feature update. When releasing major versions, we only accept language once the new version is complete. Otherwise, the language files would need to be updated. +> - Make sure we aren't in the middle of a new feature update. When releasing major versions, we only accept changes to translations once the new version is complete. Otherwise, the language files would need to be updated. > > Please speak to us before starting a language PR. We want to use your time effectively. From bc21fa47495ecf11b79b11a5682f4b76be5603e7 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 3 Jul 2023 19:00:56 +0100 Subject: [PATCH 22/29] docs(contributing): rename planned label to approved --- .github/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bc6ae37b..ccf3272e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -40,7 +40,7 @@ To make a GitHub issue for movie-web, please visit the [new issue page](https:// When filling out an issue template, please include as much detail as possible and any screenshots or console logs as appropriate. -After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will set the https://github.com/movie-web/movie-web/labels/planned label. +After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will set the https://github.com/movie-web/movie-web/labels/approved label. ## Before you start! Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). @@ -52,7 +52,7 @@ If a pull request is opened before an issue is created and accepted, you may ris > **Note** > The exception to this are language contributions, which are discussed in [this section](#language-contributions) -Also, make sure that the issue you would like to work on has been given the https://github.com/movie-web/movie-web/labels/planned label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste! +Also, make sure that the issue you would like to work on has been given the https://github.com/movie-web/movie-web/labels/approved label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste! ## Contributing If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to movie-web; it means a lot :heart: From 468ee4dcf6c27f8d937e7d78149eaa42f31dd24a Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 4 Jul 2023 17:08:33 +0100 Subject: [PATCH 23/29] docs(pr-template): add pull request template --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..f0f0d3dc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +# Pull request + +This pull request closes issue: #XXX + + - [ ] I have read and agreed to the [code of conduct](https://github.com/movie-web/movie-web/blob/dev/.github/CODE_OF_CONDUCT.md). + - [ ] I have read and complied with the [contributing guidelines](https://github.com/movie-web/movie-web/blob/dev/.github/CONTRIBUTING.md). + - [ ] What I'm implementing was assigned to me and is an [approved issue](https://github.com/movie-web/movie-web/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved). For reference see our [GitHub projects](https://github.com/movie-web/movie-web/projects). + - [ ] I have tested all of my changes. From f7ebb6ed89f2971db26fc5e58524b8c47f8ef57e Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 4 Jul 2023 17:12:46 +0100 Subject: [PATCH 24/29] docs(contributing): fix contents link --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ccf3272e..481a9343 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,7 +6,7 @@ Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community ap ## Contents - [New Contributor Guide](#new-contributor-guide) - - [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-an-bug) + - [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-a-bug) - [Discord Server](#discord-server) - [GitHub Issues](#github-issues) - [Before you start](#before-you-start) From f6af13f7a6ec49901a02b2431650c8d4e721a617 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 4 Jul 2023 17:16:04 +0100 Subject: [PATCH 25/29] docs(contributing): change issue page link to one with approved label filter --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 481a9343..9ec32b0d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -43,7 +43,7 @@ When filling out an issue template, please include as much detail as possible an After an issue is created, it will be assigned either the https://github.com/movie-web/movie-web/labels/bug or https://github.com/movie-web/movie-web/labels/feature label, along with https://github.com/movie-web/movie-web/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will set the https://github.com/movie-web/movie-web/labels/approved label. ## Before you start! -Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues). +Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/movie-web/movie-web/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved). GitHub issues are how we track our bugs and feature requests that will be implemented into movie-web - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on. From e0009c8f29fbeb47d734924fc6ecb0b24418757e Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 4 Jul 2023 17:16:21 +0100 Subject: [PATCH 26/29] docs(contributing): add new line to warning message --- .github/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9ec32b0d..a4092e52 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -90,6 +90,7 @@ Like most apps, our translations are stored in `.json` files. Each language stri Each language file is called `translation.json` and is stored in the `src/setup/languages//` folder. For example, the English language file is located at `src/setup/languages/en/translation.json`. > **Warning** +> > Before you start a translation, please: > - Check there isn't an existing GitHub [issue](https://github.com/movie-web/movie-web/issues) or [pull request](https://github.com/movie-web/movie-web/pulls) open for the language. > - Make sure we aren't in the middle of a new feature update. When releasing major versions, we only accept changes to translations once the new version is complete. Otherwise, the language files would need to be updated. From 3103ecd0041038f8f01ab812656266a3c25f24ad Mon Sep 17 00:00:00 2001 From: mrjvs Date: Thu, 13 Jul 2023 19:15:57 +0200 Subject: [PATCH 27/29] Fix wrong targeted episode on GoMovies --- src/backend/providers/gomovies.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/backend/providers/gomovies.ts b/src/backend/providers/gomovies.ts index ddd43509..169fcee7 100644 --- a/src/backend/providers/gomovies.ts +++ b/src/backend/providers/gomovies.ts @@ -103,7 +103,7 @@ registerProvider({ )?.number; const targetEpisode = episodesData.find((ep) => - ep.number ? +ep.number : ep.number === episodeNumber + ep.number ? +ep.number === episodeNumber : false ); if (!targetEpisode?.dataId) throw new Error("Episode not found"); From bd40165bc214f55a17e4b210c588b4f407c050eb Mon Sep 17 00:00:00 2001 From: William Oldham Date: Thu, 13 Jul 2023 18:37:03 +0100 Subject: [PATCH 28/29] docs(pr-template): minor changes to pr template Remove heading Update closes issue to conform to the spec fix grammary --- .github/pull_request_template.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f0f0d3dc..c072b7f5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,6 @@ -# Pull request - -This pull request closes issue: #XXX +This pull request resolves #XXX - [ ] I have read and agreed to the [code of conduct](https://github.com/movie-web/movie-web/blob/dev/.github/CODE_OF_CONDUCT.md). - [ ] I have read and complied with the [contributing guidelines](https://github.com/movie-web/movie-web/blob/dev/.github/CONTRIBUTING.md). - - [ ] What I'm implementing was assigned to me and is an [approved issue](https://github.com/movie-web/movie-web/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved). For reference see our [GitHub projects](https://github.com/movie-web/movie-web/projects). + - [ ] What I'm implementing was assigned to me and is an [approved issue](https://github.com/movie-web/movie-web/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved). For reference, please take a look at our [GitHub projects](https://github.com/movie-web/movie-web/projects). - [ ] I have tested all of my changes. From d9c944a8fac0c3da3736df6bd54b731f8f6d23db Mon Sep 17 00:00:00 2001 From: William Oldham Date: Thu, 13 Jul 2023 18:37:38 +0100 Subject: [PATCH 29/29] chore: bump version number for patch fix --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 327ba30b..32d7f081 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "movie-web", - "version": "3.1.2", + "version": "3.1.3", "private": true, "homepage": "https://movie-web.app", "dependencies": {