# Checklist projet

Tous les projets doivent :

* [ ] Être [open source](/ressources/developper/principes-de-developpement/open-source.md)
* [ ] Se récupérer avec `git checkout ...`
* [ ] Démarrer avec `docker compose up (-d)`

Voici ce que contiennent nos projets :

* [ ] Pour la documentation :
  * [ ] Le `README.md`, synthétisant ce que fait l'application, ainsi que des liens pertinents au projet
  * [ ] `CONTRIBUTING.md`
  * [ ] [`LICENCE(.txt)`](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository), voir [ici](https://www.data.gouv.fr/fr/pages/legal/licences/) pour la liste des licences
  * [ ] Un dossier `doc(s)` pour les documents techniques (choix de conception, ADRs, conventions spécifiques à l'équipe, etc.)
* [ ] Des fichiers liés à Git :
  * [ ] `.gitignore`
  * [ ] Un dossier `.github` avec les workflows du projet, et/ou des templates d'[issues](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository) et [PRs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)
* [ ] Des fichiers liés à la conteneurisation du projet, pour une exécution locale :
  * [ ] Les fichiers liés à Docker : `docker-compose.yml` et `Dockerfile` dans chaque partie applicative (front, back)
  * [ ] `.dockerignore`
* [ ] Des fichiers relatifs au projet :
  * [ ] `package.json`
  * [ ] [`pnpm-lock.yaml`](https://pnpm.io/) ou [`yarn.lock`](https://classic.yarnpkg.com/en/)
  * [ ] `tsconfig.json`
  * [ ] Les fichiers de configuration pour [Eslint](https://dnum-ministeres-sociaux.gitbook.io/ressources/), [Prettier](https://prettier.io/docs/configuration), [Editorconfig](https://editorconfig.org/), [Husky](https://github.com/typicode/husky#readme), [Lint-Staged](https://github.com/lint-staged/lint-staged#readme)
  * [ ] Pour les tests, [Vitest](https://vitest.dev/config/) est recommandé, ou [Jest](https://jestjs.io/docs/getting-started)
  * [ ] Les fichiers `.env` et `.env.ENVIRONNEMENT` qui contiennent les variables d'environnement
  * [ ] La configuration pour [Sentry](https://sentry.io/welcome/)
* [ ] Pour un projet front-end :
  * [ ] Les fichiers [vite](https://vite.dev/config/)
  * [ ] La configuration pour [Lighthouse](https://developer.chrome.com/docs/lighthouse/overview)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dnum-ministeres-sociaux.gitbook.io/ressources/developper/checklist-projet.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.