Al/new data pr template

[ALidghi]

Fixes

Fixes #12 by @ALidghi

Description

This PR creates a new PR template for the data team

Technical details

Definition of Done

• I followed the Arkhn Code Book (I swear!).
• I have written tests for the code I added or updated.
• I have updated the documentation according to my changes.
• I have updated the deployment configuration if needed.

Tests

[Jasopaum]

I might be wrong but I don't think github allows multiple PR templates as it does for issues

[nrogerarkhn]

I might be wrong but I don't think github allows multiple PR templates as it does for issues

It is possible (see this documentation).

However, usage might be a bit overwhelming if the UI doesn't allow to choose explicitly:

[MaelleBaillet5]

To add as below?

• I have shared this issue with my team (channel data-team)

[ALidghi]

The first part of the template is about creating a new model and not about an issue, that's why we kept this box only in the issue section of the template :)

[ALidghi]

I might be wrong but I don't think github allows multiple PR templates as it does for issues

It is possible (see this documentation).

However, usage might be a bit overwhelming if the UI doesn't allow to choose explicitly:

Indeed, there is the issue of dealing with multiple templates to address. It seems that this stackoverflow thread adresses it by suggesting two non-perfect solutions :

I found a more convenient solution for this today. The problem with the current answer(s) is that you either need to create a custom URL, or create an additional template outside of the PULL_REQUEST_TEMPLATE directory.

The alternative is to use a symlink, like this:

cd .github
ln -s PULL_REQUEST_TEMPLATE/pull_request_template.md pull_request_template.md
git add pull_request_template.md
git commit -m "Add symlink to default pull request template"
Once merged into the default branch, any new pull requests created through github.com will use the linked template.

And

You can create a manual template selection, such that at least developers who open a PR can click on a link to get to their respective template:

Assuming you have two templates group_a_template.md and group_b_template.md under .github/PULL_REQUEST_TEMPLATE

Create the default template .github/pull_request_template.md with the following content

Please go the the `Preview` tab and select the appropriate sub-template:

* [Group A](?expand=1&template=group_a_template.md)
* [Group B](?expand=1&template=group_b_template.md)
In this way, people who open a PR interactively in the UI will first get to the default template and can open their respective target template from the "Preview" view.

Not optimal, but more convenient than patching the URL manually every time you submit a PR.

Or use the url to choose which template we want to use as github suggests it, but as @nrogerarkhn said it can be a bit overwhelming.

[nrogerarkhn]

Indeed, there is the issue of dealing with multiple templates to address. It seems that this stackoverflow thread adresses it by suggesting two non-perfect solutions :

I found a more convenient solution for this today. The problem with the current answer(s) is that you either need to create a custom URL, or create an additional template outside of the PULL_REQUEST_TEMPLATE directory.

The alternative is to use a symlink, like this:

cd .github
ln -s PULL_REQUEST_TEMPLATE/pull_request_template.md pull_request_template.md
git add pull_request_template.md
git commit -m "Add symlink to default pull request template"
Once merged into the default branch, any new pull requests created through github.com will use the linked template.

And

You can create a manual template selection, such that at least developers who open a PR can click on a link to get to their respective template:

Assuming you have two templates group_a_template.md and group_b_template.md under .github/PULL_REQUEST_TEMPLATE

Create the default template .github/pull_request_template.md with the following content

Please go the the `Preview` tab and select the appropriate sub-template:

* [Group A](?expand=1&template=group_a_template.md)
* [Group B](?expand=1&template=group_b_template.md)
In this way, people who open a PR interactively in the UI will first get to the default template and can open their respective target template from the "Preview" view.

Not optimal, but more convenient than patching the URL manually every time you submit a PR.

Or use the url to choose which template we want to use as github suggests it, but as @nrogerarkhn said it can be a bit overwhelming.

I kinda like the second solution, it's a quite elegant way to get around the problem in my opinion!

[ALidghi]

• SQLFMT pose problème avec les fonctions FHIR et la gestion des quotes (à tester sur le codex, voir le retirer de la PR du template)
• SQLFLUFF déjà sur le pre-commit, à retirer du template PR
• gérer le doublon de template de PR (tech/data)
• Formulation à reprendre, partager le fardeau
• comparer les pre-commit déjà implémenter dans le codex et ce template de PR : https://github.com/arkhn/codex/blob/main/.github/workflows/pre-commit.yml