doc: Add an item to PR template about data import

Probesys · Aug 2, 2024 · 0896d38 · 0896d38
1 parent 12ea090
commit 0896d38
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -17,6 +17,7 @@
 
 - [ ] code is manually tested
 - [ ] permissions / authorizations are verified
+- [ ] data can be imported correctly
 - [ ] interface works on both mobiles and big screens
 - [ ] interface works in both light and dark modes
 - [ ] interface works on both Firefox and Chrome

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -83,6 +83,12 @@ Bileto is based on a custom system of roles.
 This system is explained in the document [“Roles & permissions”](/docs/developers/roles.md).
 This item reminds you to put the required actions behind an authorization.
 
+#### “Data can be imported correctly”
+
+When new entities or fields are created, we need to consider making this data importable by [the `DataImporter` service](/src/Service/DataImporter/DataImporter.php).
+However, not all data needs to be imported.
+If fields are changed or removed, the service needs to be adjusted as well.
+
 #### “Interface works on both mobile and big screen”
 
 We want Bileto to work on desktop and mobiles.