Merge pull request #352 from movie-web/meta/code-of-conduct

Community Standards

.github/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.

.github/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing Guidelines for movie-web
+
+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 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-a-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:
+
+- [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 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 want to discuss a feature or bug with us before making an issue, you can join our Discord server.
+
+<a href="https://discord.movie-web.app"><img src="https://discord.com/api/guilds/871713465100816424/widget.png?style=banner2" alt="Discord Server"></a>
+
+### 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 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/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?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.
+
+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 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:
+
+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 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)
+- [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. 
+
+### 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. 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 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`) that references a language string in the appropriate language file.
+
+Each language file is called `translation.json` and is stored in the `src/setup/languages/<language code>/` 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.
+>
+> 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 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.
+   - 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 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.

.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

.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

.github/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)

.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.

README.md

@@ -5,7 +5,7 @@
 <a href="https://github.com/movie-web/movie-web/blob/master/LICENSE.md"><img alt="GitHub license" src="https://img.shields.io/github/license/movie-web/movie-web?style=flat-square"></a>
 <a href="https://github.com/movie-web/movie-web/network"><img alt="GitHub forks" src="https://img.shields.io/github/forks/movie-web/movie-web?style=flat-square"></a>
 <a href="https://github.com/movie-web/movie-web/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/movie-web/movie-web?style=flat-square"></a><br/>
-<a href="https://discord.gg/vXsRvye8BS"><img src="https://discordapp.com/api/guilds/871713465100816424/widget.png?style=banner2" alt="Discord Server"></a>
+<a href="https://discord.movie-web.app"><img src="https://discord.com/api/guilds/871713465100816424/widget.png?style=banner2" alt="Discord Server"></a>
 </p>
 
 movie-web is a web app for watching movies easily. Check it out at **[movie-web.app](https://movie-web.app)**.

SELFHOSTING.md

@@ -1,39 +1,41 @@
-# 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 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 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
+3. If it asks you, choose a subdomain.
-4. If it asks for a workers plan, press "Continue with free"
+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`
+5. Create a new service with a name of your choice. Must be type `HTTP handler`.
-6. On the service page, Click `Quick edit`
+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)
+7. Remove the template code in the quick edit window.
-8. Open the downloaded `worker.js` file in notepad, VScode or similar.
+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.
+3. Open `config.js` in Notepad, Visual Studio Code 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.
+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
 
-Your client has been prepared, you can now host it on any webhost.
+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, its just a standard static page.
+It doesn't require PHP, it's just a standard static page.