... | ... | @@ -10,11 +10,11 @@ If you want open a ticket on Gitlab, the following information is needed: |
|
|
# Other contributions
|
|
|
|
|
|
[You can help in many ways](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contributing):
|
|
|
- [Code contributions](doc/install.devel.markdown)
|
|
|
- Code contributions
|
|
|
- UX and UI designs ([example](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/issues/356#note_244099))
|
|
|
- Testing
|
|
|
- [Translating](https://translations.openpaper.work)
|
|
|
- Documentation (markdown files or [LyX](https://www.lyx.org/)/[PDF files](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/tree/master/paperwork-gtk/doc)
|
|
|
- Documentation (markdown files or [LyX](https://www.lyx.org/) / [PDF files](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/tree/master/paperwork-gtk/src/paperwork_gtk/model/help/doc)
|
|
|
integrated in Paperwork)
|
|
|
|
|
|
For most tasks, being familiar with Git is really helpful.
|
... | ... | @@ -27,12 +27,12 @@ Sometimes [IRC](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Con |
|
|
|
|
|
# Code contribution
|
|
|
|
|
|
[OpenPaperwork-core documentation](https://doc.openpaper.work/openpaperwork_core/latest/)
|
|
|
[OpenPaperwork-core documentation](https://doc.openpaper.work/openpaperwork_core/latest/index.html)
|
|
|
|
|
|
Rules are:
|
|
|
|
|
|
* All commits go to the branch `develop`. I (Jflesch) will cherry-pick them in the branches `master` (stable) or `testing` (release) if required.
|
|
|
* Paperwork is made to be *simple* to use (think simple enough that your own mother could install and use it)
|
|
|
* Paperwork is made to be *simple* to use (think simple enough that your own mother could use it)
|
|
|
* Paperwork is open-source software (GPLv3+)
|
|
|
* Run `make check` and `make test`. If they fail, your changes will be rejected.
|
|
|
* Consider adding automated tests.
|
... | ... | @@ -59,12 +59,13 @@ Regarding PEP-8, the following rules must be strictly followed: |
|
|
1. Lines are at most 80 characters long
|
|
|
2. Indentation is done using 4 spaces
|
|
|
|
|
|
You can check you follow the rules using `source ./activate_test_env.sh && make check`. You can run the unit tests with `source ./activate_test_env.sh && make test`
|
|
|
|
|
|
|
|
|
# Continous Integration and Delivery
|
|
|
|
|
|
There is a [Continous Integration and Delivery](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/pipelines) running.
|
|
|
All changes must leave the CI/CD OK. You can have look at the file
|
|
|
.gitlab-ci.yml to know what the CI/CD build and check.
|
|
|
All changes must leave the CI/CD OK. You can have look at the file .gitlab-ci.yml to know what the CI/CD build and check.
|
|
|
|
|
|
|
|
|
# Branches
|
... | ... | |