5.2 KiB

Raw Blame History

Contributing to Overseerr

All help is welcome and greatly appreciated. If you would like to contribute to the project, the instructions below can get you started...

Development

Tools Required

HTML/Typescript/Javascript editor of choice. (VSCode is recommended. Upon opening the project, a few extensions will be automatically recommended for install.)
NodeJS (Node 12.x.x or higher)
Yarn
Git

Getting Started

Fork the repository to your own GitHub account and then clone it to your local device.
```
git clone https://github.com/YOUR_USERNAME/overseerr.git
cd overseerr/
```

Add the remote upstream.

git remote add upstream https://github.com/sct/overseerr.git

Create a new branch
```
git checkout -b BRANCH_NAME develop
```
- It is recommended to name the branch something relevant to the feature or fix you are working on.
- An example of this would be fix-title-cards or feature-new-system.
- Bad examples would be patch or bug.
Run development environment
```
yarn
yarn dev
```
- Alternatively you can run using Docker with docker-compose up -d. This method does not require installing NodeJS or Yarn on your machine directly.
Create your patch and run appropriate tests.
Follow the guidelines.

Should you need to update your fork, you can do so by rebasing from upstream:

git fetch upstream
git rebase upstream/develop
git push origin BRANCH_NAME -f

Contributing Code

If you are taking on an existing bug or feature ticket, please comment on the GitHub Issue to avoid multiple people working on the same thing.
All commits must follow Conventional Commits
- It is okay if you squash your PR down to be a single commit that fits this standard.
- PRs with commits not following this standard will not be merged.
Please make meaningful commits, or squash them.
Always rebase your commit to the latest develop branch. Do not merge develop into your branch.
It is your responsibility to keep your branch up to date. It will not be merged unless its rebased off the latest develop branch.
You can create a "draft" pull request early to get feedback on your work.
Your code must be formatted correctly or the tests will fail.
- We use Prettier to format our codebase. It should automatically run with a git hook, but it is recommended to have the Prettier extension installed in your editor and format on save.
If you have questions or need help, you can reach out in GitHub Discussions or in our Discord.
Only open pull requests to develop. Never master. Any PRs opened to master will be closed.

UI Text Style

When adding new UI text, please be sure to adhere to the following guidelines:

Be concise and clear, and use as few words as possible to make your point.
Use the Oxford comma where appropriate.
Use the appropriate Unicode characters for ellipses, arrows, and other special characters/symbols.
Capitalize proper nouns, such as Plex, Radarr, Sonarr, Telegram, Slack, Pushover, etc. Be sure to also use the official capitalization for any abbreviations; e.g., TMDb and IMDb have a lowercase 'b', whereas TheTVDB has a capital 'B'.
Title case headings, button text, and form labels. Note that verbs such as "is" should be capitalized, whereas prepositions like "from" should be lowercase (unless as the first or last word of the string, in which case they are also capitalized).
Capitalize the first word in validation error messages, dropdowns, and form "tips." These strings should not end in punctuation.
Ensure that toast notification strings are complete sentences ending in punctuation.
If an additional description or "tip" is required for a form field, it should be styled using the global CSS class label-tip.
In full sentences, abbreviations like "info" or "auto" should not be used in place of full words, unless referencing the name/label of a specific setting or option which has an abbreviation in its name.
Do your best to check for spelling errors and grammatical mistakes.
Do not misspell "Overseerr."

Translation

We use Weblate for our translations, and your help with localizing Overseerr would be greatly appreciated! If your language is not listed below, please open a feature request on GitHub.

Attribution

This contribution guide was inspired by the Next.js and Radarr contribution guides.

5.2 KiB Raw Blame History