If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome.
If you want to implement something big:
- Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together.
- When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project.
- Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change.
- Please see the paperless-ngx merge process below.
Paperless supports python 3.8 and 3.9. We format Python code with Black.
main always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases.
dev contains all changes that will be part of the next release. Use this branch to start making your changes.
feature-X branches are for experimental stuff that will eventually be merged into dev.
Please format and test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
To test your code, execute pytest in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing.
Before you can run pytest, ensure to properly set up your local environment.
... is available in the documentation. https://paperless-ngx.readthedocs.io/en/latest/extending.html
Once you have submitted a Pull Request it will be reviewed, approved, and merged by one or more community members of any team. Automated code tests and formatting checks must be passed.
PRs deemed non-trivial will go through a stricter review process before being merged into dev. This is to ensure code quality and complete functionality (free of side effects).
Examples of non-trivial PRs might include:
- Additional features
- Large changes to many distinct files
- Breaking or depreciation of existing features
Our community review process for non-trivial PRs is the following:
- Must pass usual automated code tests and formatting checks.
- The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes).
- Development team will check and test code manually (possibly over several days).
- You may be asked to make changes or rebase.
- The team may ask for additional testing done by @paperless-ngx/test
- At least two members of the team will approve and finally merge the request into
dev🎉.
This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler.
Some notes about translation:
- There are two resources:
src-ui/messages.xlfcontains the translation strings for the front end. This is the most important.django.pocontains strings for the administration section of paperless, which is nice to have translated.
- Most of the front-end strings are used on buttons, menu items, etc., so ideally the translated string should not be much longer than the English original.
- Translation units may contain placeholders. These usually mean that there's a name of a tag or document or something in the string. You can click on the placeholders to copy them.
- Translation units may contain plural expressions such as
{PLURAL_VAR, plural, =1 {one result} =0 {no results} other {<placeholder> results}}. Copy these verbatim and translate only the content in the inner{}brackets. Example:{PLURAL_VAR, plural, =1 {Ein Ergebnis} =0 {Keine Ergebnisse} other {<placeholder> Ergebnisse}} - Changes to translations on Crowdin will get pushed into the repository automatically.
If a language has already been added, and you would like to contribute new translations or change existing translations, please read the "Translation" section in the README.md file for further details on that.
If you would like the project to be translated to another language, first head over to https://crwd.in/paperless-ngx to check if that language has already been enabled for translation. If not, please request the language to be added by creating an issue on GitHub. The issue should contain:
- English name of the language (the localized name can be added on Crowdin).
- ISO language code. A list of those can be found here: https://support.crowdin.com/enterprise/language-codes/
- Date format commonly used for the language, e.g. dd/mm/yyyy, mm/dd/yyyy, etc.
After the language has been added and some translations have been made on Crowdin, the language needs to be enabled in the code. Note that there is no need to manually add a .po of .xlf file as those will be automatically generated and imported from Crowdin. The following files need to be changed:
- src-ui/angular.json (under the projects/paperless-ui/i18n/locales JSON key)
- src/paperless/settings.py (in the LANGUAGES array)
- src-ui/src/app/services/settings.service.ts (inside the getLanguageOptions method)
- src-ui/src/app/app.module.ts (import locale from angular/common/locales and call registerLocaleData)
Please add the language in the correct order, alphabetically by locale. Note that en-us needs to stay on top of the list, as it is the default project language
If you are familiar with Git, feel free to send a Pull Request with those changes. If not, let us know in the issue you created for the language, so that another developer can make these changes.
Paperless-ngx is a community project. We do our best to delegate permission and responsibility among a team of people to ensure the longevity of the project.
As of writing, there are 21 members in paperless-ngx. 4 of these people have complete administrative privileges to the repo:
There are 5 teams collaborating on specific tasks within paperless-ngx:
- @paperless-ngx/backend (Python / django)
- @paperless-ngx/frontend (JavaScript / Typescript)
- @paperless-ngx/ci-cd (GitHub Actions / Deployment)
- @paperless-ngx/issues (Issue triage)
- @paperless-ngx/test (General testing for larger PRs)
All team members are notified when mentioned or assigned to a relevant issue or pull request. Additionally, each team has slightly different access to paperless-ngx:
- The test team has no special permissions.
- The issues team has
triageaccess. This means they can organize issues and pull requests. - The backend, frontend, and ci-cd teams have
writeaccess. This means they can approve PRs and push code, containers, releases, and more.
We are not overly strict with inviting people to the organization. If you have read the team permissions and think having additional access would enhance your contributions, please reach out to an admin of the team.
The admins occasionally invite contributors directly if we believe having them on a team will accelerate their work.