Recommendations for First Time Contributors

[thornbill]

Contribute with Code

If you are looking for a code change to work on, then checkout the open issues or look for a new feature or task on the unoffical roadmap. Specifically the items labelled as Good First Issue should be good options for beginners.

Another great place to check for easy tasks to get started with is the list of code smells on SonarCloud. Some of these are more complex, but others are as simple as removing code that has been commented out or removing an unused variable. The list can be filtered for a specific Rule in the left pane. In most cases, it probably makes sense to make a separate PR per rule fixed. When possible add an eslint rule to prevent future issues of the same type.

If you have any questions or encounter any development issues, feel free to reach out via chat in one of our development chat rooms. Details can be found on the Contact page.

Adding new features

• Complex features or changes to core functionality should start as discussions on the meta repo with a general implementation plan. Sign off on the planned implementation by the Jellyfin team should be given before opening a PR. This ensures the implementation follows best practices and falls inline with team goals.
• New code should use the target architecture when possible: TypeScript, Jellyfin TypeScript SDK, TanStack Query, and React.
  • Additionally the Dashboard and Experimental app should use the MUI component library.

Other Ways to Contribute

• Triage open issues by testing to see if an issue can be reproduced and comment with your findings.
• Test and review open PRs and leave comments with your findings.
  • Specifically any issues tagged with the needs testing label could use additional help with testing.
• Contribute to translations.

[pypp]

is the unoffical roadmap still relevant ?

[thornbill]

Yes it is. I update it regularly.

[strawHat121]

Hi @thornbill

There are a lot of issues on the sonarcloud and many of them are like 2 3 years old. Can those be picked by anyone to work on as many of them seems easy enough for a beginner to do ?

[thornbill]

Hey @strawHat121! They are all up for grabs. The only ones that I am aware of that may present some challenges for new contributors are the issues with catching errors for promises. Some places in the old code are expected to throw (in particular closing modals/dialogs/etc.) and that is not very obvious. Otherwise most are pretty easy fixes imho and sonar just flagged a bunch of new types of issues recently. 😅

[strawHat121]

Thanks for the update @thornbill

I see some small tasks there like using of an Optional Chain expression and usage of nullish coalescing operator. Will start from there.