|
|
## Paperwork needs you !
|
|
|
|
|
|
<img src="http://www.riverlandwine.com.au/images/News/323_wgga.png" width="320" height="170" />
|
|
|
|
|
|
As any other open-source project, Paperwork needs all the help it can get. Of course code contributions are welcome, but there are many other tasks where anyone can help.
|
|
|
|
|
|
If you want to help, [feel free to come chat with us](https://github.com/openpaperwork/paperwork/wiki/Contact#mailing-list).
|
|
|
|
|
|
|
|
|
### Code contributor
|
|
|
|
|
|
Main contributor: [Jflesch](https://github.com/jflesch/)
|
|
|
|
|
|
The most obvious way to contribute, but not the easiest one.
|
|
|
|
|
|
Paperwork has no clear road map: Paperwork has and will evolve based on features for which people are willing to contribute time. Each developer is free to have its own road map.
|
|
|
|
|
|
If you choose to contribute code, beware [there are a few rules to follow](https://github.com/openpaperwork/paperwork/wiki/Coding-rules).
|
|
|
|
|
|
If you're looking for a place to start, the [bug tracker](https://github.com/openpaperwork/paperwork/issues) is full of bugs to fix and crazy ideas to implement :-). Beware that tickets with the label 'to study' must be discussed further first before starting writing code.
|
|
|
|
|
|
If you need help for anything, don't hesitate to ask either on the mailing-list or IRC. We will gladly do our best to help you.
|
|
|
|
|
|
|
|
|
### UX and UI designer
|
|
|
|
|
|
Main contributor: [Mjourdan](https://github.com/mjourdan)
|
|
|
|
|
|
A long time ago, Mjourdan has opened a ticket [full of suggestions to improve the user interface of Paperwork](https://github.com/openpaperwork/paperwork/issues/356). This ticket was full of good ideas. It has also shown that making mock-ups before implementing anything is a *really* good idea ;-)
|
|
|
|
|
|
Paperwork tries to follow [Gnome HIG Guidelines](https://developer.gnome.org/hig/stable/) as much as possible.
|
|
|
I (Jflesch) also try to keep configurations and settings to a strict minimum to keep things dead simple.
|
|
|
|
|
|
### Testers
|
|
|
|
|
|
Before every important release of Paperwork, there is a testing phase (release candidate). This phase lasts about 1 month. While there are [some automated tests](https://github.com/openpaperwork/paperwork-tests), most of the tests are unfortunately [manual tests](https://github.com/openpaperwork/paperwork-tests/blob/master/manual_tests.csv).
|
|
|
In a perfect world, Paperwork tests should be run on all possible platforms and distributions.
|
|
|
|
|
|
Testing phases are announce on the mailing-list.
|
|
|
|
|
|
Main testers:
|
|
|
* Linux/Flatpak/Gnome tester: [Jflesch](https://github.com/jflesch/)
|
|
|
* Linux/Debian/Gnome tester: [Jflesch](https://github.com/jflesch/)
|
|
|
* Linux/Ubuntu/Unity tester: ?
|
|
|
* Windows tester: ?
|
|
|
|
|
|
|
|
|
### Translators
|
|
|
|
|
|
Paperwork is much nicer to look at in your native language, and it can always use more translations.
|
|
|
Unfortunately, at the moment, [translating Paperwork requires Linux, some basic knowledge of the shell and Git](https://github.com/openpaperwork/paperwork/wiki/Translating).
|
|
|
|
|
|
The best time to translate Paperwork is when it enters testing phase: Before each important release, there is a test phase of about one month. This phase is announced on the mailing-list.
|
|
|
|
|
|
Note that the UI will keep changing after your first translations, and they will need to be updated. Since it's better to have no UI translations at all than incomplete UI translations, unmaintained translations will be removed.
|
|
|
|
|
|
Documentation can be translated too (example: [intro.lyx](https://github.com/openpaperwork/paperwork/blob/master/doc/intro.lyx) -> [intro_fr.lyx](https://github.com/openpaperwork/paperwork/blob/master/doc/intro_fr.lyx)).
|
|
|
|
|
|
[Openpaper.work](https://github.com/openpaperwork/openpaper.work) can be [translated too](https://docs.djangoproject.com/fr/1.11/topics/i18n/translation/).
|
|
|
|
|
|
Main contributors:
|
|
|
* English (default): [Jflesch](https://github.com/jflesch)
|
|
|
* French: [Jflesch](https://github.com/jflesch)
|
|
|
* German: [Mirodin](https://github.com/Mirodin)
|
|
|
|
|
|
|
|
|
### Documentation writer
|
|
|
|
|
|
Paperwork has a documentation embedded. It is written with [Lyx](https://www.lyx.org/).
|
|
|
|
|
|
* [Introduction to Paperwork](https://github.com/openpaperwork/paperwork/blob/master/doc/intro.lyx)
|
|
|
* [User Manual](https://github.com/openpaperwork/paperwork/blob/master/doc/usage.lyx)
|
|
|
|
|
|
While the introduction won't probably change often, the user manual is far from complete. There are empty sections, and probably a lot of sections we haven't thought of yet.
|
|
|
|
|
|
|
|
|
### Distribution packagers
|
|
|
|
|
|
Paperwork intends to be as simple to use as possible. To make its installation as simple as possible, Paperwork must be packaged in GNU/Linux distributions (Flatpak is still to hard to use for my grandmother).
|
|
|
|
|
|
The following libraries and program must be packaged:
|
|
|
- [PyOCR](https://github.com/openpaperwork/pyocr)
|
|
|
- [Pyinsane](https://github.com/openpaperwork/pyinsane)
|
|
|
- [Libpillowfight](https://github.com/openpaperwork/libpillowfight)
|
|
|
- [Paperwork-backend](https://github.com/openpaperwork/paperwork-backend)
|
|
|
- [Paperwork (GUI)](https://github.com/openpaperwork/paperwork)
|
|
|
|
|
|
New releases of Paperwork or any of its dependencies are announced on the mailing-list. If you decide to package Paperwork, please keep an eye on the mailing-list.
|
|
|
|
|
|
Packagers:
|
|
|
* Linux/ArchLinux: [StreakyCobra](https://github.com/StreakyCobra)
|
|
|
* Linux/Debian | Linux/Ubuntu: ?
|
|
|
* Linux/Fedora: ?
|
|
|
* Linux/Flatpak: [Jflesch](https://github.com/jflesch/)
|
|
|
* Linux/Gentoo: [Voyageur](https://github.com/voyageur)
|
|
|
* FreeBSD: ?
|
|
|
* Windows: [Jflesch](https://github.com/jflesch/)
|
|
|
|
|
|
|
|
|
### Web designer
|
|
|
|
|
|
I (Jflesch) made the design of [openpaper.work]. Let's face it .. it's ugly.
|
|
|
So if you think you can do better, please, by all means, do ! :-)
|
|
|
|
|
|
If you can update the [Django templates](https://github.com/openpaperwork/openpaper.work) yourself, it's even better.
|
|
|
|
|
|
|
|
|
### Sysadmin
|
|
|
|
|
|
[Openpaper.work](https://openpaper.work) is hosted on a dedicated server. This server also updates each night the Flatpak repository.
|
|
|
Here are some of the piece of software currently used on the server:
|
|
|
* GNU/Linux Debian
|
|
|
* LXC containers
|
|
|
* Iptables
|
|
|
* Apache2
|
|
|
* [Python 3 + Django](https://github.com/openpaperwork/openpaper.work)
|
|
|
* Flatpak-builder
|
|
|
* Cron
|
|
|
* Postfix
|
|
|
|
|
|
There are [many evolutions that would benefit Paperwork development](https://github.com/openpaperwork/paperwork/issues?q=is%3Aissue+is%3Aopen+label%3Ainfrastructure).
|
|
|
|
|
|
At some point in the future, it is my hope [that Paperwork will be hosted on gnome.org and maybe even become part of Gnome](https://github.com/openpaperwork/paperwork/issues/627). But joining Gnome will also imply migrating to Gnome's infrastructure (Gitlab, Damn Lies, etc) as much as possible. |
|
|
\ No newline at end of file |