1 changed files with 38 additions and 0 deletions
@ -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! |
||||||
|
|
||||||
|
<a href="https://discord.movie-web.app"><img src="https://discordapp.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 make sure to include as much detail as possible and include any screenshots or console logs as appropriate. |
Loading…
Reference in new issue