This site is still a work in progress. For the current docs, head to dictionarry.dev.
profilarr
Ctrl K

Loading index...

↑↓ navigate ↵ open esc close
Home
Quick Start
Installation
Build
Test
Deploy
Monitoring
FAQ
Community
Contributing
Sponsor
API Reference
Dictionarry
Dev Logs
Wiki

Contributing

Last updated

Contributions are welcome, whether that’s code, database changes, or fixes to these docs. Small fixes can go straight to a pull request. For anything bigger, open an issue or ask on Discord first, so we can agree on the approach before you put time into it. To report a bug or request a feature, see Community.

Profilarr

Profilarr’s code lives in Dictionarry-Hub/profilarr.

Setting Up

You’ll need Git, Deno, and Node.js. The .NET SDK is only needed for the parser, which powers custom format and quality profile testing. The repository’s .tool-versions file pins the version of each.

Terminal
git clone https://github.com/Dictionarry-Hub/profilarr.git
cd profilarr
deno task dev

deno task dev starts the parser and the Vite dev server together.

Making a Change

Branch off develop, keep the pull request to one feature or fix, and open it against develop. Pull requests are squash merged, so the title becomes the commit message and has to follow Conventional Commits, such as fix: sync status not updating after save. You don’t need to write tests; the maintainer writes them.

Before you start, know that:

  • The PCD module, which covers the op replay system, the compile pipeline, and the export flow, is off-limits without discussing it with the maintainer first.
  • AI tools are fine as assistants, but the contribution has to be yours. You need to understand the change and be able to answer questions about it. Pull requests that look like unreviewed generated output may be closed.

The full workflow, including rebasing onto develop, naming, and code conventions, is in CONTRIBUTING.md. The branching model and release process are in DEVELOPMENT.md.

Databases

Profiles, custom formats, and regular expressions come from databases, and each database lives in its own repository with its own maintainers. For the Dictionarry database, ask on Discord or open an issue on Dictionarry-Hub/database. For any other database, check its repository.

To run a database of your own, see Maintaining a Database.

These Docs

This site lives in Dictionarry-Hub/profilarr.com. Each docs page is a Markdown file under src/routes/docs/, so fixing a typo or a wrong step can be as small as editing that file on GitHub and opening a pull request against develop. For local setup and conventions, see the site’s CONTRIBUTING.md.