Contributing

Contributions are welcome! Here's how to get involved.

---

Reporting issues

If something doesn't work as expected, please open an issue. Include:

• What you expected to happen
• What actually happened
• Your Docker image version (docker inspect or the tag you used)
• Relevant log output (docker logs <container-name>)

---

Submitting a fix or improvement

1. Fork the repository and create a branch. Use a descriptive name:

   fix/retry-loop-broken
   perf/faster-history-queries
   feat/new-ai-provider
   

2. Make your changes and test them locally (see below).

3. Open a pull request against the main branch. Describe what you changed and why.

---

Testing locally

# Install dependencies
npm install

# Start with auto-reload
npm run test

The application will be available at http://localhost:3000. You'll still need a running Paperless-ngx instance to connect to.

---

Code style

Run the formatter before committing:

npx prettier --write .

---

Questions?

Feel free to open a discussion or issue on GitHub. There's no strict contribution process – just be clear about what you're changing and why.