-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into fix/vt-declutter-param
- Loading branch information
Showing
30 changed files
with
582 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Compiler | ||
|
||
Si vous souhaitez contribuer au code des extensions Geoplateforme, voici les commandes principales | ||
|
||
## Installation des dépendances | ||
|
||
``` bash | ||
npm install | ||
``` | ||
|
||
Attention, il peut parfois y avoir du cache. | ||
Dans ce cas : | ||
|
||
``` bash | ||
rm package-lock.json | ||
npm install --force --verbose | ||
``` | ||
|
||
## Génération des exemples | ||
|
||
``` bash | ||
npm run sample:modules | ||
npm run sample:bundle | ||
``` | ||
|
||
Lance un navigateur avec les pages d'exemples servies sur l'adresse https://localhost:8080/samples/index-modules.html ou https://localhost:8080/samples/index-bundle.html | ||
|
||
Les pages html de test d'utilisation sont dans le répertoire *samples-src/*. | ||
|
||
## Build des sources | ||
|
||
> resultat du build dans le répoertoire *dist/* | ||
``` bash | ||
npm run build | ||
npm run build:bundle | ||
npm run build:modules | ||
``` | ||
|
||
**Construction des modules** | ||
|
||
``` bash | ||
npm run publish | ||
``` | ||
|
||
Créé le dossier */dist/package/*, et le fichier *.tgz* nommé à partir de la version renseignée dans le package.json (ex. *geopf-extensions-openlayers-1.0.0-beta.1-324.tgz* si la version renseignée des api est 1.0.0-beta.1-234 dans le package.json) | ||
|
||
## D'autres commandes utiles | ||
|
||
``` bash | ||
npm run eslint | ||
npm run generate-types | ||
npm run generate-jsdoc | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# Contribuer | ||
|
||
Si vous souhaitez contribuer au code des extensions Geoplateforme, voici quelques conseils pratiques et règles à suivre. | ||
|
||
<!-- toc --> | ||
|
||
- [Ouverture d'un ticket (issue)](#ouverture-dun-ticket-issue) | ||
- [Ouvrir une pull request (PR)](#ouvrir-une-pull-request-pr) | ||
* [On «fork» le projet](#on-%C2%ABfork%C2%BB-le-projet) | ||
* [On code...](#on-code) | ||
* [On soumet une PR...](#on-soumet-une-pr) | ||
- [Liens utiles](#liens-utiles) | ||
|
||
<!-- tocstop --> | ||
|
||
## Ouverture d'un ticket (issue) | ||
|
||
Vous pouvez ouvrir un ticket dans les situations suivantes : | ||
|
||
* Signaler une erreur que vous ne pouvez pas résoudre vous-même | ||
* Discuter d'un sujet ou d'une idée relatives au projet | ||
* Proposer une nouvelle fonctionnalité ou une évolution de fonctionnalité | ||
|
||
Votre ticket est ensuite pris en compte par les membres de l'équipe ou de la communauté. Et une action peut vous être demandée telle qu'**ouvrir une Pull Request** afin de contribuer... | ||
|
||
## Ouvrir une pull request (PR) | ||
|
||
Une pull request vous permet de soumettre une proposition d'évolution du code source à l'équipe en charge du projet. Voici comment soumettre une **pull request** ! | ||
|
||
### On «fork» le projet | ||
|
||
- Créez un `fork` du projet sur le Github. | ||
- Cloner le en local. Ce `dépôt distant` sur le Github s'appelle `origin`. | ||
- Ajoutez le dépôt d'origine en tant que `dépôt distant` avec le mot cléf : `upstream` (cf. https://help.github.com/articles/configuring-a-remote-for-a-fork/). | ||
- Si vous avez créé votre `fork` il y a quelque temps, assurez-vous de récupérer les modifications dans votre dépôt local (cf. https://help.github.com/articles/syncing-a-fork/). | ||
- Récupérez les modification le plus souvent possible de "upstream" afin d'être le plus à jour possible, de sorte que lorsque vous soumettez votre demande (PR), les conflits de fusion seront plus faciles à résoudre ! | ||
|
||
### On code... | ||
|
||
- Créez une `nouvelle branche` pour travailler. Nommez la : | ||
- feature-nom-de-la-feature (ex. feature-widget-draw-circle) dans le cas d'une branche qui propose une nouvelle fonctionnalité | ||
- fix-problème (ex. fix-mouse-position-projection-dropdown) dans le cas d'une branche qui propose une correction à un problème. Si le problème corrigé est lié à une issue, ne pas hésiter à mettre son numéro dans le titre de la branche (ex. fix-152-mouse-position-projection-dropdown) | ||
|
||
- Dans le répertoire local du projet, installez les dépendances du projet : | ||
|
||
``` bash | ||
npm install | ||
``` | ||
|
||
cf. [COMPILE.md](COMPILE.md) pour plus d'infos. | ||
|
||
- Ecrivez testez, corrigez votre `code` sur votre copie locale de votre fork. | ||
|
||
Les commandes pour lancer les exemples en mode modules ou bundle: | ||
|
||
``` | ||
npm run sample:modules | ||
npm run sample:bundle | ||
``` | ||
Lance un navigateur avec les pages d'exemples servies sur l'adresse https://localhost:8080/samples/index-modules.html ou https://localhost:8080/samples/index-bundle.html | ||
Les pages html de test d'utilisation sont dans le répertoire *samples-src/*. | ||
|
||
|
||
- Suivez les règles de codage du projet. Elles sont définies dans le fichier : .eslintrc (style et convention de codage + syntaxe JavaScript). Vous pouvez vérifier le bon respect de ces règles en lançant la tache : | ||
|
||
``` | ||
npm run eslint | ||
``` | ||
|
||
- Vérifiez, ajoutez ou adaptez les exemples si nécessaire. | ||
|
||
* Les pages d'exemples sont dans le répertoire *samples-src/pages/tests* | ||
|
||
- Ajoutez ou modifiez la `documentation` si nécessaire. Si votre PR apporte une modification d'interface à la bibliothèque, mettez à jour la jsDoc en conséquences et vérifiez quelle est bien prise en compte. | ||
|
||
La commande | ||
|
||
``` | ||
npm run generate-jsdoc | ||
``` | ||
|
||
Vous permet de générer la jsDoc du projet dans le répertoire *jsdoc/*. | ||
Ouvrez ensuite dans votre navigateur le fichier *jsdoc/index.html* et vérifiez que vos modifications sont bien prises en compte. | ||
|
||
- Rajoutez vous dans le fichier [CONTRIBUTORS.md](CONTRIBUTORS.md]) si vous n'y êtes pas déjà. | ||
|
||
- `Squash` vos commit en un seul avec le `rebase interactif` (cf. https://help.github.com/articles/interactive-rebase) ou via d'autre méthodes (cf. https://gist.github.com/patik/b8a9dc5cd356f9f6f980 par exemple) | ||
|
||
- Poussez cette branche sur votre dépôt, sur le dépôt marqué `origin`. | ||
|
||
|
||
### On soumet une PR... | ||
|
||
- De votre `fork`, ouvrez une demande de `pull request` sur cette branche (cf. https://help.github.com/articles/creating-a-pull-request/). Et ciblez sur la branche `main` du dépôt d'origine... | ||
- Référencez tous les problèmes ainsi que la documentation sur votre PR. | ||
- Ajoutez un ou plusieurs label(s) à votre PR | ||
- Utilisez dans vos `commit` des fonctionnalités de GitHub (ex. "Fix #37."). | ||
- Si le responsable demande des modifications supplémentaires, il suffit de les pousser vers votre branche locale, la `pull request` se met à jour automatiquement. | ||
- Une fois que la `pull request` est approuvée, les responsables du projet effectueront le merge (cf. https://help.github.com/articles/merging-a-pull-request/). | ||
|
||
|
||
## Liens utiles | ||
|
||
https://help.github.com/articles/configuring-a-remote-for-a-fork/ | ||
https://help.github.com/articles/syncing-a-fork/ | ||
https://help.github.com/articles/about-pull-requests/ | ||
https://help.github.com/articles/creating-a-pull-request/ | ||
https://help.github.com/articles/checking-out-pull-requests-locally/ | ||
https://help.github.com/articles/merging-a-pull-request/ | ||
https://help.github.com/articles/about-pull-request-merges/ | ||
https://help.github.com/articles/interactive-rebase | ||
|
||
Un exemple de contribution sur un projet (en français) : | ||
https://git-scm.com/book/fr/v2/GitHub-Contribution-%C3%A0-un-projet |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
samples-src/templates/partials/packages/partials-ol-bundle-dsfr-head.hbs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
samples-src/templates/partials/packages/partials-ol-bundle-head.hbs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
samples-src/templates/partials/packages/partials-ol-modules-dsfr-head.hbs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
samples-src/templates/partials/packages/partials-ol-modules-head.hbs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.