mirror of
https://github.com/sussy-code/smov.git
synced 2024-12-20 14:37:43 +01:00
Update old github folder
This commit is contained in:
parent
3163584fd7
commit
aebcfe9f25
5 changed files with 25 additions and 29 deletions
3
.github/CODEOWNERS
vendored
3
.github/CODEOWNERS
vendored
|
@ -1 +1,2 @@
|
||||||
* @movie-web/project-leads
|
* Maintainers: [MW-Exodus Team](https://github.com/MW-Legacy)
|
||||||
|
* Founer: (sussy-code)[https://github.com/sussy-code], (sudo-flix)[https://github.com/sudo-flix]
|
||||||
|
|
2
.github/CODE_OF_CONDUCT.md
vendored
2
.github/CODE_OF_CONDUCT.md
vendored
|
@ -60,7 +60,7 @@ representative at an online or offline event.
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported to the community leaders responsible for enforcement at
|
reported to the community leaders responsible for enforcement at
|
||||||
our [Discord](https://movie-web.github.io/links/discord).
|
our [Discord](https://discord.gg/7FrXjCrDyp).
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
|
37
.github/CONTRIBUTING.md
vendored
37
.github/CONTRIBUTING.md
vendored
|
@ -1,11 +1,11 @@
|
||||||
# Contributing Guidelines for movie-web
|
# Contributing Guidelines for sudo-flix
|
||||||
|
|
||||||
Thank 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.
|
Thank 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.
|
||||||
|
|
||||||
Please 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
|
## Contents
|
||||||
- [Contributing Guidelines for movie-web](#contributing-guidelines-for-movie-web)
|
- [Contributing Guidelines for sudo-flix](#contributing-guidelines-for-sudo-flix)
|
||||||
- [Contents](#contents)
|
- [Contents](#contents)
|
||||||
- [New contributor guide](#new-contributor-guide)
|
- [New contributor guide](#new-contributor-guide)
|
||||||
- [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-a-bug)
|
- [Requesting a feature or reporting a bug](#requesting-a-feature-or-reporting-a-bug)
|
||||||
|
@ -30,34 +30,34 @@ To get an overview of the project, read the [README](README.md). Here are some r
|
||||||
## Requesting a feature or reporting a bug
|
## Requesting a feature or reporting a bug
|
||||||
There are two places where to request features or report bugs:
|
There are two places where to request features or report bugs:
|
||||||
- GitHub Issues
|
- GitHub Issues
|
||||||
- The movie-web Discord server
|
- The sudo-flix Discord server
|
||||||
|
|
||||||
### 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.
|
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://movie-web.github.io/links/discord"><img src="https://discord.com/api/guilds/871713465100816424/widget.png?style=banner2" alt="Discord Server"></a>
|
<a href="https://sudo-flix.github.io/links/discord"><img src="https://discord.com/api/guilds/871713465100816424/widget.png?style=banner2" alt="Discord Server"></a>
|
||||||
|
|
||||||
### GitHub Issues
|
### 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.
|
To make a GitHub issue for sudo-flix, please visit the [new issue page](https://github.com/sussy-code/smov/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.
|
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.
|
After an issue is created, it will be assigned either the https://github.com/sussy-code/smov/labels/bug or https://github.com/sussy-code/smov/labels/feature label, along with https://github.com/sussy-code/smov/labels/awaiting-approval. One of our maintainers will review your issue and, if it's accepted, will set the https://github.com/sussy-code/smov/labels/approved label.
|
||||||
|
|
||||||
## Before you start!
|
## 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).
|
Before starting a contribution, please check your contribution is part of an open issue on [our issues page](https://github.com/sussy-code/smov/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.
|
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.
|
||||||
|
|
||||||
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!
|
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**
|
> **Note**
|
||||||
> The exception to this are language contributions, which are discussed in [this section](#language-contributions)
|
> 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!
|
Also, make sure that the issue you would like to work on has been given the https://github.com/sussy-code/smov/labels/approved label by a maintainer. Otherwise, if we reject the issue, it means your work will have gone to waste!
|
||||||
|
|
||||||
## Contributing
|
## 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 sudo-flix; it means a lot :heart:
|
||||||
|
|
||||||
Firstly, make sure you've read the [Before you start!](#before-you-start) section!
|
Firstly, make sure you've read the [Before you start!](#before-you-start) section!
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ When you have found a GitHub issue you would like to work on, you can request to
|
||||||
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.
|
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
|
### Recommended Development Environment
|
||||||
Our recommended development environment to work on movie-web is:
|
Our recommended development environment to work on sudo-flix is:
|
||||||
- [Visual Studio Code](https://code.visualstudio.com/)
|
- [Visual Studio Code](https://code.visualstudio.com/)
|
||||||
- [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
- [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||||
- [EditorConfig Extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
- [EditorConfig Extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
||||||
|
@ -80,18 +80,13 @@ Here are some tips to make sure that your pull requests are :pinched_fingers: fi
|
||||||
|
|
||||||
- KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code!
|
- KISS - Keep It Simple Soldier! - Simple code makes readable and efficient code!
|
||||||
- Follow standard best practices for TypeScript and React.
|
- 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!
|
- Keep as much as possible to the style of sudo-flix. 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.
|
- 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.
|
- Test, test, test! Make sure you thoroughly test the features you are contributing.
|
||||||
|
|
||||||
### Language Contributions
|
### Language Contributions
|
||||||
Language contributions help movie-web massively, allowing people worldwide to use our app!
|
Language contributions help sudo-flix massively, allowing people worldwide to use our app!
|
||||||
|
|
||||||
We use Weblate for crowdsourcing our translations. [Click here to go to our translation tool.](https://movie-web.github.io/links/weblate)
|
1. Create a new langague json file
|
||||||
|
2. Implement the langague file into settings
|
||||||
|
3. Thats it make a PR
|
||||||
1. First make sure you make an account. (click the link above)
|
|
||||||
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.
|
|
||||||
3. In the top right of the screen, click "translate"
|
|
||||||
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".
|
|
||||||
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.
|
|
||||||
|
|
6
.github/SECURITY.md
vendored
6
.github/SECURITY.md
vendored
|
@ -2,9 +2,9 @@
|
||||||
|
|
||||||
## Supported Versions
|
## Supported Versions
|
||||||
|
|
||||||
The latest version of movie-web is the only version that is supported, as it is the only version that is being actively developed.
|
The latest version of sudo-flix is the only version that is supported, as it is the only version that is being actively developed.
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
You can contact the movie-web maintainers to report a vulnerability:
|
You can contact the sudo-flix maintainers to report a vulnerability:
|
||||||
- Report the vulnerability in the [movie-web Discord server](https://movie-web.github.io/links/discord)
|
- Report the vulnerability in the [Discord](https://discord.gg/7FrXjCrDyp).
|
6
.github/pull_request_template.md
vendored
6
.github/pull_request_template.md
vendored
|
@ -1,6 +1,6 @@
|
||||||
This pull request resolves #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 agreed to the [code of conduct](https://github.com/sussy-code/smov/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).
|
- [ ] I have read and complied with the [contributing guidelines](https://github.com/sussy-code/smov/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, please take a look at our [GitHub projects](https://github.com/movie-web/movie-web/projects).
|
|
||||||
- [ ] I have tested all of my changes.
|
- [ ] I have tested all of my changes.
|
||||||
|
- [x] I love sudo-flix
|
||||||
|
|
Loading…
Reference in a new issue