···11-# Contributing Guidelines for sudo-flix
11+# Contributing Guidelines for P-Stream
2233Thank you for investing your time in contributing to our project! Your contribution will be reflected on all of the community hosted instances that are on the latest version.
4455Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
6677## Contents
88-- [Contributing Guidelines for sudo-flix](#contributing-guidelines-for-sudo-flix)
99- - [Contents](#contents)
1010- - [New contributor guide](#new-contributor-guide)
1111- - [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-a-bug)
1212- - [Discord Server](#discord-server)
1313- - [GitHub Issues](#github-issues)
1414- - [Before you start!](#before-you-start)
1515- - [Contributing](#contributing)
1616- - [Recommended Development Environment](#recommended-development-environment)
1717- - [Tips](#tips)
1818- - [Language Contributions](#language-contributions)
88+ - [New Contributor Guide](#new-contributor-guide)
99+ - [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-a-bug)
1010+ - [Discord Server](#discord-server)
1111+ - [GitHub Issues](#github-issues)
1212+ - [Before you start](#before-you-start)
1313+ - [Contributing](#before-you-start)
1414+ - [Recommended Development Environment](#recommended-development-environment)
1515+ - [Tips](#tips)
1616+ - [Language Contributions](#language-contributions)
19172018## New contributor guide
2119···29273028## Requesting a feature or reporting a bug
3129There are two places where to request features or report bugs:
3030+ - The P-Stream Discord server
3231 - GitHub Issues
3333- - The sudo-flix Discord server
34323533### Discord Server
3636-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.
3737-[Join bruh](https://docs.pstream.mov/links/discord)
3434+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.
3535+3636+<a href="https://docs.pstream.mov/links/discord"><img src="https://discord.com/api/guilds/1267558147682205738/widget.png?style=banner2" alt="Discord Server"></a>
38373938### GitHub Issues
4040-To make a GitHub issue for sudo-flix, please visit the [new issue page](https://github.com/p-stream/p-stream/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template.
3939+To make a GitHub issue for P-Stream, please visit the [new issue page](https://github.com/p-stream/p-stream/issues/new/choose) where you can pick either the "Bug Report" or "Feature Request" template.
41404241When filling out an issue template, please include as much detail as possible and any screenshots or console logs as appropriate.
4342···4645## Before you start!
4746Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/p-stream/p-stream/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved).
48474949-GitHub issues are how we track our bugs and feature requests that will be implemented into sudo-flix - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on.
4848+GitHub issues are how we track our bugs and feature requests that will be implemented into P-Stream - all contributions **must** have an issue and be approved by a maintainer before a pull request can be worked on.
50495150If 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!
5251···5655Also, make sure that the issue you would like to work on has been given the https://github.com/p-stream/p-stream/labels/approved label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste!
57565857## Contributing
5959-If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to sudo-flix; it means a lot :heart:
5858+If you're here because you'd like to work on an issue, amazing! Thank you for even considering contributing to P-Stream; it means a lot :heart:
60596160Firstly, make sure you've read the [Before you start!](#before-you-start) section!
6261···6564If 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.
66656766### Recommended Development Environment
6868-Our recommended development environment to work on sudo-flix is:
6767+Our recommended development environment to work on P-Stream is:
6968- [Visual Studio Code](https://code.visualstudio.com/)
7069- [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
7170- [EditorConfig Extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
···79788079- KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code!
8180- Follow standard best practices for TypeScript and React.
8282-- Keep as much as possible to the style of sudo-flix. Look around our codebase to familiarise yourself with how we do things!
8181+- Keep as much as possible to the style of P-Stream. Look around our codebase to familiarise yourself with how we do things!
8382- Ensure to take note of the ESLint errors and warnings! **Do not ignore them!** They are there for a reason.
8483- Test, test, test! Make sure you thoroughly test the features you are contributing.
85848685### Language Contributions
8787-Language contributions help sudo-flix massively, allowing people worldwide to use our app!
8686+Language contributions help P-Stream massively, allowing people worldwide to use our app!
8787+8888+We use Weblate for crowdsourcing our translations. [Click here to go to our translation tool.](https://docs.pstream.mov/links/weblate)
8989+88908989-1. Create a new langague json file
9090-2. Implement the langague file into settings
9191-3. Thats it make a PR
9191+1. First make sure you make an account. (click the link above)
9292+2. Click the language you want to help translate, if it's not listed you can click the plus top left to add a new language.
9393+3. In the top right of the screen, click "translate"
9494+4. Here you will be prompted a key to translate, fill in a translation and proceed to the next item by pressing "save and continue".
9595+5. Thats all there is to it, every translation will eventually come through and be pushed with an update. This usually doesn't take longer than a week.
.github/P-Stream.png
This is a binary file and will not be displayed.
+3-3
.github/SECURITY.md
···2233## Supported Versions
4455-The latest version of sudo-flix is the only version that is supported, as it is the only version that is being actively developed.
55+The latest version of P-Stream is the only version that is supported, as it is the only version that is being actively developed.
6677## Reporting a Vulnerability
8899-You can contact the sudo-flix maintainers to report a vulnerability:
1010- - Report the vulnerability in the [Discord](https://docs.pstream.mov/links/discord).
99+You can contact the P-Stream maintainers to report a vulnerability:
1010+ - Report the vulnerability in the [P-Stream Discord server](https://docs.pstream.mov/links/discord)
···11This pull request resolves #XXX
2233- - [ ] I have read and agreed to the [code of conduct](https://github.com/p-stream/p-stream/blob/production/.github/CODE_OF_CONDUCT.md).
44- - [ ] I have read and complied with the [contributing guidelines](https://github.com/p-stream/p-stream/blob/production/.github/CONTRIBUTING.md).
33+ - [ ] I have read and agreed to the [code of conduct](https://github.com/p-stream/p-stream/blob/dev/.github/CODE_OF_CONDUCT.md).
44+ - [ ] I have read and complied with the [contributing guidelines](https://github.com/p-stream/p-stream/blob/dev/.github/CONTRIBUTING.md).
55+ - [ ] What I'm implementing was assigned to me and is an [approved issue](https://github.com/p-stream/p-stream/issues?q=is%3Aopen+is%3Aissue+label%3Aapproved). For reference, please take a look at our [GitHub projects](https://github.com/p-stream/p-stream/projects).
56 - [ ] I have tested all of my changes.
66- - Enter discord user: `` (we require this for the contributor role)