Content
View differences
Updated by Jens Ulferts over 2 years ago
See ##40867 for the full picture.
In the code, rename fields:
* estimated time / estimated hours => Work
* `estimated[ _]?(hours|time)`
* remaining time / remaining hours => Remaining work
* `remaining[ _]?(hours|time)`
* Progress (%) / done ratio / percentage done => % Complete
* `done[_ ]?ratio|percentage[_ ]?done|progress \(?%\)?`
The renaming in code is important to keep an ubiquitous language between code, UI and API and avoid errors.
For renamings in API, both the old and the new attributes should be provided. The old attribute should be deprecated, but still work so as not to break clients.
Warning: wiki macro names should be renamed too to match the new names. A migration should be issued. For instance, rename `workPackageValue:1234:remainingTime` as `workPackageValue:1234:remainingWork`, and `workPackageValue:1234:estimatedTime` as `workPackageValue:1234:work`. Please see the relevant [attributes for wiki macro documentation](https://www.openproject.org/fr/docs/guide-utilisateur/wysiwyg/#attributs-disponibles-pour-les-lots-de-travaux).
The fields are also used in work package queries. So they are persisted in the `queries` table (`filters`, `column_names` and `sort_criteria`).
In the code, rename fields:
* estimated time / estimated hours => Work
* `estimated[ _]?(hours|time)`
* remaining time / remaining hours => Remaining work
* `remaining[ _]?(hours|time)`
* Progress (%) / done ratio / percentage done => % Complete
* `done[_ ]?ratio|percentage[_ ]?done|progress \(?%\)?`
The renaming in code is important to keep an ubiquitous language between code, UI and API and avoid errors.
For renamings in API, both the old and the new attributes should be provided. The old attribute should be deprecated, but still work so as not to break clients.
Warning: wiki macro names should be renamed too to match the new names. A migration should be issued. For instance, rename `workPackageValue:1234:remainingTime` as `workPackageValue:1234:remainingWork`, and `workPackageValue:1234:estimatedTime` as `workPackageValue:1234:work`. Please see the relevant [attributes for wiki macro documentation](https://www.openproject.org/fr/docs/guide-utilisateur/wysiwyg/#attributs-disponibles-pour-les-lots-de-travaux).
The fields are also used in work package queries. So they are persisted in the `queries` table (`filters`, `column_names` and `sort_criteria`).