Skip to content

Commit afd6d83

Browse files
Better readme (#1240)
Added more detailed information for the setup of the work environment for the new member such as: Detailed instructions to configure the Dart and Flutter extension on Android Studio. Added link to other documentation. (ie. Contributing documentation, Flutter, etc.) Added French translation of the CONTRIBUTING.md file. Updated the French version of the README. md file to match the English version. Other minor fixes.
1 parent 0593aab commit afd6d83

File tree

6 files changed

+261
-64
lines changed

6 files changed

+261
-64
lines changed

CONTRIBUTING.fr.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contribuer
2+
3+
Lors de la contribution à ce répertoire, veuillez commencer par discuter des changements que vous
4+
souhaitez appliquer par le biais d'un "_issue_", email, ou tout autre moyen avec le propriétaire de ce
5+
répertoire.
6+
7+
Prendre note que nous avons un code de conduite, veuillez le suivre pour toutes vos interactions
8+
avec ce projet.
9+
10+
## Processus de codage
11+
12+
1. Nommer votre branche en suivant le format suivant:
13+
`{feature/patch/bugfix}/#{issue number}-{issue description}`
14+
- Exemple: `feature/#68-migration-to-null-safety`
15+
2. Laisser le code dans un meilleur état qu’avant vos modifications. Cela signifie effectuer une
16+
refactoring dans les zones autour du code modifié.
17+
3. Testez vos modifications à l’aide de tests unitaires.
18+
4. Exécutez `flutter analyze` avant de soumettre une demande d’extraction et corrigez les problèmes
19+
découverts.
20+
21+
### Contrôle de version
22+
23+
Le CI met automatiquement à jour la version dans le fichier `pubspec.yaml` en ouvrant une "
24+
pull request" en utilisant les étiquettes: `version: Major`,`version: Minor` ou `version: Patch`.
25+
26+
- `version: Major`: utilisé lorsqu'un changement complet de UI est effectué ou lorsqu'un changement
27+
majeur dans le fonctionnement du projet.
28+
- `version: Minor`: utilisé lorsqu'une nouvelle fonctionnalité est ajouté dans l'application
29+
- `version: Patch`: utilisé lorsque aucune fonctionnalité a été ajouté au projet. Cela inclut le
30+
formatage, patches, correction de bug, etc.
31+
32+
## Processus des "Pull Request"
33+
34+
1. **Définir un problème relié**
35+
36+
Si vous voulez suggérer des modifications, svp faire un `Issue` pour en discuter.
37+
<br/>Pour plus d'information:
38+
[Lien de la documentation sur les "GitHub Issues"](https://docs.github.com/fr/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
39+
<br/>SVP inscrire le `Issue` ici: (utiliser le mot-clé `closes: #12345`)
40+
41+
2. **Description**
42+
43+
Décrire vos changements en détails.
44+
45+
3. **Est-ce que cela a été testé ?**
46+
47+
S'il vous plait, décrire comment vous avez testé vos changements.
48+
Inclure les détails de vos tests unitaires ansi que les tests manuel effectués, comment vos
49+
changement ont affecté le code de d'autre fichiers, etc.
50+
51+
4. **Liste à remplir avant de demander un révision de code**
52+
53+
Assurer vous de bien remplir ces critère selon la nature de vos modifications:
54+
55+
- [ ] J'ai performé une auto-révision de mon code
56+
- [ ] Si c'est une fonctionnalité mère, j'ai ajouté des tests approfondis.
57+
- [ ] Devons-nous mettre en œuvre des analyses?
58+
- [ ] Assurez-vous d’ajouter l’une des étiquettes suivantes: `version: Major`,`version: Minor` ou
59+
`version: Patch`.
60+
61+
5. **Capture d'écran (si nécessaire)**
62+
63+
Si c’est un changement visuel, veuillez fournir une capture d’écran.
64+
65+
## Code de Conduite
66+
67+
### Notre Engagement
68+
69+
Afin de favoriser un environnement ouvert et accueillant, nous les contributeurs et mainteneurs
70+
s’engagent à participer à notre projet et notre communauté une expérience sans harcèlement pour tout
71+
le monde, peu importe l’âge, condition physique, handicap, origine ethnique, identité et expression
72+
de genre, niveau d’expérience, nationalité, apparence personnelle, race, religion ou identité
73+
sexuelle et orientation.
74+
75+
### Nos Standards
76+
77+
Voici des exemples de comportements qui contribuent à la création d’un environnement positif:
78+
79+
* Utiliser un langage accueillant et inclusif
80+
* Respecter les points de vue et les expériences différents
81+
* Accepter gracieusement les critiques constructives
82+
* Se concentrer sur ce qui est le mieux pour la collectivité
83+
* Faire preuve d’empathie envers les autres membres de la communauté
84+
85+
Voici des exemples de comportements inacceptables:
86+
87+
* L'utilisation d'un langage ou d'images sexualisés, d'une attention ou d'avances sexuelles non désirées.
88+
* Trolling, insultes/commentaires désobligeants et attaques personnelles ou politiques
89+
* Harcèlement public ou privé
90+
* Publier les renseignements personnels d’autrui, comme une adresse physique ou électronique, sans
91+
autorisation explicite
92+
* Autres comportements qui pourraient raisonnablement être considérés comme inappropriés dans un
93+
contexte professionnel
94+
95+
### Nos Responsabilités
96+
97+
Les responsables du projet sont chargés de clarifier les normes de comportement acceptable et
98+
doivent prendre des mesures correctives appropriées et équitables en réponse à tout cas de
99+
comportement inacceptable.
100+
101+
Les responsables du projet ont le droit et la responsabilité de supprimer, modifier ou rejeter des
102+
commentaires, des confirmations, du code, des modifications au wiki, des problèmes et d’autres
103+
contributions qui ne sont pas alignées sur ce code de conduite, ou d’interdire temporairement ou
104+
définitivement tout contributeur pour d’autres comportements qu’ils jugent inappropriés, menaçants,
105+
offensants ou nuisibles.
106+
107+
### Champ d'Application
108+
109+
Ce code de conduite s’applique aussi bien dans les espaces du projet que dans les espaces publics
110+
lorsqu’une personne représente le projet ou sa communauté. Les exemples de représentation d’un
111+
projet ou d’une communauté comprennent l’utilisation d’une adresse électronique officielle du
112+
projet, la publication par l’intermédiaire d’un compte officiel sur les médias sociaux ou le fait
113+
d’agir en tant que représentant désigné à un événement en ligne ou hors ligne. La représentation
114+
d’un projet peut être définie et clarifiée par les responsables du projet.
115+
116+
### Application des Règlement
117+
118+
Les cas de comportement abusif, harcelant ou inacceptable peuvent être signalés en communiquant avec
119+
l’équipe du projet à [applets@etsmtl.ca](mailto:applets@etsmtl.ca). Toutes les plaintes feront
120+
l’objet d’un examen et d’une enquête, et donneront lieu à une réponse jugée nécessaire et appropriée
121+
aux circonstances. L’équipe de projet est tenue de respecter la confidentialité à l’égard du
122+
déclarant d’un incident. De plus amples détails sur les politiques d’application spécifiques peuvent
123+
être affichés séparément.
124+
125+
Les responsables du projet qui ne suivent pas ou n’appliquent pas le code de bonne foi peuvent être
126+
confrontés à des répercussions temporaires ou permanentes déterminées par d’autres membres de la
127+
direction du projet.
128+
129+
### Attribution
130+
131+
Le présent code de conduite est une adaptation du [Contributor Covenant](http://contributor-covenant.org), version 1.4,
132+
disponible à l’adresse suivante: [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/)

CONTRIBUTING.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
11
# Contributing
22

33
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
4+
email, or any other method with the owners of this repository before making a change.
55

66
Please note we have a code of conduct, please follow it in all your interactions with the project.
77

88
## Coding Process
99

10-
1. Name your branch using the following format: `{feature/patch/bugfix}/#{issue number}-{issue description}`
11-
- Example: `feature/#68-migration-to-null-safety`
12-
2. Leave the code in a better state than before your changes. That does mean performing refactoring in the areas around the modified code.
10+
1. Name your branch using the following format:
11+
`{feature/patch/bugfix}/#{issue number}-{issue description}`
12+
- Example: `feature/#68-migration-to-null-safety`
13+
2. Leave the code in a better state than before your changes. That does mean performing refactoring
14+
in the areas around the modified code.
1315
3. Test your changes using unit tests.
1416
4. Run `flutter analyze` before submitting a pull request and fix any discovered issues.
1517

1618
### Versioning
1719

18-
The CI automatically updates the version in the `pubspec.yaml` file when opening a pull-request using the specified label: `version: Major`,`version: Minor` or `version: Patch`.
20+
The CI automatically updates the version in the `pubspec.yaml` file when opening a pull-request
21+
using the specified label: `version: Major`,`version: Minor` or `version: Patch`.
1922

20-
- `version: Major`: used when a complete UI redesign is done or when a complete rewrite is done in the project;
21-
- `version: Minor`: used when adding a feature in the application;
22-
- `version: Patch`: used when no feature was added to the project. This includes refactoring, patches, bug fixes, etc.
23+
- `version: Major`: used when a complete UI redesign is done or when a complete rewrite is done in
24+
the project;
25+
- `version: Minor`: used when adding a feature in the application;
26+
- `version: Patch`: used when no feature was added to the project. This includes refactoring,
27+
patches, bug fixes, etc.
2328

2429
## Pull Request Process
2530

2631
1. **Define a related Issue**
2732

28-
If suggesting a new feature or change, please discuss it in an issue first
29-
For more explanation: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
30-
Please link the issue here: (use keyword `closes: #12345`)
33+
If suggesting a new feature or change, please discuss it in an issue first.
34+
<br/>For more explanation:
35+
[GitHub Issue Documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
36+
<br/>Please link the issue here: (use keyword `closes: #12345`)
3137

3238
2. **Description**
3339

@@ -42,10 +48,11 @@ see how your change affects other areas of the code, etc.
4248
4. **Checklist before requesting a review**
4349

4450
Make sure to fill out the following checklist for a change request:
45-
- [ ] I have performed a self-review of my code.
46-
- [ ] If it is a core feature, I have added thorough tests.
47-
- [ ] Do we need to implement analytics?
48-
- [ ] Make sure to add either one of the following labels: `version: Major`,`version: Minor` or `version: Patch`.
51+
52+
- [ ] I have performed a self-review of my code.
53+
- [ ] If it is a core feature, I have added thorough tests.
54+
- [ ] Do we need to implement analytics?
55+
- [ ] Make sure to add either one of the following labels: `version: Major`,`version: Minor` or `version: Patch`.
4956

5057
5. **Screenshots (if useful)**
5158

@@ -76,7 +83,7 @@ include:
7683
Examples of unacceptable behavior by participants include:
7784

7885
* The use of sexualized language or imagery and unwelcome sexual attention or
79-
advances
86+
advances
8087
* Trolling, insulting/derogatory comments, and personal or political attacks
8188
* Public or private harassment
8289
* Publishing others' private information, such as a physical or electronic
@@ -108,7 +115,7 @@ further defined and clarified by project maintainers.
108115
### Enforcement
109116

110117
Instances of abusive, harassing, or otherwise unacceptable behavior may be
111-
reported by contacting the project team at applets@etsmtl.ca. All
118+
reported by contacting the project team at [applets@etsmtl.ca](mailto:applets@etsmtl.ca). All
112119
complaints will be reviewed and investigated and will result in a response that
113120
is deemed necessary and appropriate to the circumstances. The project team is
114121
obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -124,4 +131,5 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
124131
available at [http://contributor-covenant.org/version/1/4][version]
125132

126133
[homepage]: http://contributor-covenant.org
134+
127135
[version]: http://contributor-covenant.org/version/1/4/

README.fr.md

Lines changed: 54 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="https://raw.githubusercontent.com/ApplETS/Notre-Dame/master/docs/images/ETS_logo.png" />
2+
<img src="https://raw.githubusercontent.com/ApplETS/Notre-Dame/master/docs/images/ETS_logo.png" alt="ETS"/>
33
<p>
44
<br /><strong>Projet Notre-Dame</strong>
55
<br />
@@ -9,66 +9,101 @@
99
</a>
1010
<img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/clubapplets-server/e51406de3b919a69f396642a2bcb413c/raw/notre_dame_master_badge_coverage.json" alt="Code coverage"/>
1111
<br />
12-
<img src="https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplayshields.herokuapp.com%2Fplay%3Fi%3Dca.etsmtl.applets.etsmobile%26l%3DPlay%2520Store%2520version%26m%3D%24version" alt="Play store version"/>
12+
<img src="https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dca.etsmtl.applets.etsmobile%26l%3DPlay%2520Store%2520version%26m%3Dv%24version" alt="Play store version"/>
1313
<br />
1414
<img src="https://img.shields.io/itunes/v/557463461?label=App%20Store%20version&logo=appstore" alt="App store version"/>
1515
<br />
1616
</p>
1717
</div>
1818

19-
Ce projet concrétise la quatrième version de l'application mobile ÉTSMobile pour Android et iOS. Il s'agit de portail principal entre l'utilisateur et l'École de technologie supérieure (ÉTS) sur appareils mobiles. ÉTSMobile est un projet open-source développé par les membres du club étudiant ApplETS. L'application offre notamment :
19+
Ce projet concrétise la quatrième version de l'application mobile ÉTSMobile pour Android et iOS. Il
20+
s'agit du portail principal entre l'utilisateur et
21+
l'[École de technologie supérieure (ÉTS)](https://www.etsmtl.ca/) sur appareils mobiles. ÉTSMobile
22+
est un projet open-source développé par les membres du club
23+
étudiant [ApplETS](https://clubapplets.ca/). L'application offre notamment :
2024

2125
* L'accès aux notes d'évaluations
2226
* L'accès aux horaires de cours
2327
* Et bien plus...
2428

25-
_Note: Ce guide est aussi disponible en: [English](https://github.com/ApplETS/Notre-Dame/blob/master/README.md)_
29+
<ins>_Note: This guide is also available in: [English](README.md)_<ins/>
2630

2731
## Technologies utilisées
2832

29-
* [Flutter](https://flutter.dev)
33+
* Flutter [[Accueil](https://docs.flutter.dev) |
34+
[Téléchargement](https://docs.flutter.dev/get-started/install)]
3035

3136
## Requis
3237

33-
- Flutter SDK v3.19.3 ou supérieure
38+
- Flutter SDK v3.32.0 ou supérieure
3439
- Openssl v1.1.1g ou supérieure
3540
- Java sdk 17
3641

42+
## Configuration de Flutter
43+
44+
- Télécharger le SDK Flutter à partir de la
45+
section ["Technologies utilisées"](#Technologies-utilisées)
46+
et suivre les instructions officielles.<br>
47+
(Il est recommandé d'utiliser 7-Zip pour l'extraction du fichier)
48+
- Ouvrir le menu des paramètres et s'assurer que les extensions Flutter et Dart sont bien
49+
installées.
50+
- Dans le menu des paramètres, se rendre dans la section "Languages & Frameworks".
51+
- <ins>Flutter</ins>: Ajouter le chemin vers le dossier Flutter.
52+
- <ins>Dart</ins>: Ajouter le chemin du dossier "flutter/bin/cache/dart-sdk" du dossier Flutter
53+
et cocher Notre-Dame comme projet supporté.
54+
3755
## Avant de démarrer le code
3856

39-
- Pour avoir accès a certaines fonctionnalités vous allez avoir besoin du certificat de SignetsAPI, la clef Google Drive., etc. , ces fichiers sont encrypté.
40-
Pour les décrypter vous allez devoir exécuter le script `env_variables.sh` (disponible uniquement sur le Google Drive du club),
41-
- puis exécuter les commandes suivantes à la racine du projet:
57+
- Pour avoir accès à certaines fonctionnalités vous allez avoir besoin du certificat de SignetsAPI,
58+
la clef Google Drive, etc. Ces fichiers sont encryptés.
59+
Pour les décrypter, vous allez devoir exécuter le script `env_variables.sh` (disponible uniquement
60+
sur le Google Drive du club), puis exécuter les commandes suivantes à la racine du projet:
61+
62+
### Linux
63+
4264
```sh
4365
chmod +x ./scripts/decrypt.sh
4466
chmod +x ./env_variables.sh
4567
./env_variables.sh
4668
```
4769

70+
### Windows
71+
72+
Dans une invite de commande GitBash
73+
74+
```sh
75+
sh "env_variables.sh"
76+
```
77+
4878
## Démarrer le code
4979

50-
- Pour générer les classes pour l'internationalisation, exécuter les commandes suivantes:
80+
- Pour générer les classes pour l'internationalisation (l10n), exécuter les commandes suivantes:
81+
5182
```bash
5283
flutter pub get
5384
```
5485

5586
- Pour générer les mocks:
87+
5688
```bash
5789
dart run build_runner build
5890
```
5991

60-
61-
## Ajouter une variable d'environnement pour une API_KEY
62-
- Pour ajouter le Google Maps API TOKEN et le GitHub API TOKEN, vous devez renommer le fichier `.env.template` en `.env`.
63-
Dans le fichier `.env` , vous devez ajouter le Google Maps API TOKEN et le GitHub API TOKEN.
64-
65-
6692
## Git hooks
6793

68-
Vous pouvez trouver dans le dossier `.githooks` l'ensemble des hooks pour git. Pour configurer git afin d'utiliser ce dossier, saisir la commande suivante:
94+
Vous pouvez trouver dans le dossier `.githooks` l'ensemble des hooks pour git. Pour configurer git
95+
afin d'utiliser ce dossier, saisir la commande suivante:
96+
6997
```bash
7098
git config core.hooksPath .githooks
7199
```
72100

73-
## ⚖️ License
74-
Ce projet est licencié selon la licence Apache V2.0. Voir le fichier [LICENSE](https://github.com/ApplETS/Notre-Dame/blob/master/LICENSE) pour plus d'informations.
101+
## Comment renouveler les certificats Apple
102+
103+
Suivre la procédure de
104+
ce [répertoire](https://github.com/ApplETS/fastlane-ios-certificates/blob/master/README.md),
105+
accessible uniquement par les groupes admin et devops.
106+
107+
## Comment contribuer au projet
108+
109+
Vous pouvez contribuer au projet en suivant les instructions de ce [document](CONTRIBUTING.fr.md)

0 commit comments

Comments
 (0)