Machine Translated by Google

Modèles  de  demande  d'extraction

7  exemples  de  modèles  de  demande  d'extraction  GitHub

Voici  7  exemples  de  templates  de  pull  request  que  nous  avons  créés  et  trouvés  sur  le  web :

En  savoir  plus  sur  les  modèles  de  problèmes  SteveLao  GitHub  et  des  modèles  GitHub  géniaux

Exemple 1 :  Modèle  de  demande  d'extraction  simple :

1 ##  À  quoi  sert  ce  PR ?

2
3
4 ##  Numéro  de  ticket  Jira ?
5
6 ##  Liste  de  contrôle  avant  la  fusion
7 ­  [ ]  Si  c'est  une  fonctionnalité  de  base,  j'ai  ajouté  par  test.
8 ­  [ ]  Avons­nous  besoin  de  mettre  en  œuvre  des  analyses ?
9 ­  [ ]  Cela  fera­t­il  partie  d'une  mise  à  jour  du  produit ?  Si  oui,  veuillez  écrire  une  phrase  à  propos  de  cette  mise  à  jour
dix
11

Exemple 2 :  Modèle  de  demande  d'extraction  de  liste  de  tâches

1 #  Description
2
3 Veuillez  inclure  un  résumé  de  la  modification  et  du  problème  résolu.  Veuillez  également  inclure  la  motivation  et  les  inconvénients  pertinents
4
5 Corrections  #  (problème)
6
7 ##  Type  de  changement
8
9 Veuillez  supprimer  les  options  qui  ne  sont  pas  pertinentes.
dix
11 ­  [ ]  Correction  de  bogue  (changement  ininterrompu  qui  résout  un  problème)
12 ­  [ ]  Nouvelle  fonctionnalité  (changement  ininterrompu  qui  ajoute  des  fonctionnalités)
13 ­  [ ]  Modification  avec  rupture  (correction  ou  fonctionnalité  qui  empêcherait  la  fonctionnalité  existante  de  fonctionner  comme  prévu)
14 ­  [ ]  Cette  modification  nécessite  une  mise  à  jour  de  la  documentation
15
16 #  Comment  cela  a­t­il  été  testé ?
17
18 Veuillez  décrire  les  tests  que  vous  avez  exécutés  pour  vérifier  vos  modifications.  Fournissez  des  instructions  afin  que  nous  puissions  reproduire.  S'il  te  plaît
19
20 ­  [ ]  Essai  A
21 ­  [ ]  Essai  B
22
23 **Configuration  d'essai** :
24 *  Version  du  firmware:
25 *  Matériel:
26 *  Chaîne  d'outils :
27 * SDK :

28
29 #  Liste  de  contrôle :

30
Machine Translated by Google

31 ­  [ ]  Mon  code  suit  les  directives  de  style  de  ce  projet
32 ­  [ ]  J'ai  effectué  une  auto­révision  de  mon  propre  code
33 ­  [ ]  J'ai  commenté  mon  code,  notamment  dans  les  zones  difficiles  à  comprendre
34 ­  [ ]  J'ai  apporté  les  modifications  correspondantes  à  la  documentation
35 ­  [ ]  Mes  modifications  ne  génèrent  aucun  nouvel  avertissement
36 ­  [ ]  J'ai  ajouté  des  tests  qui  prouvent  que  mon  correctif  est  efficace  ou  que  ma  fonctionnalité  fonctionne
37 ­  [ ]  Les  tests  unitaires  nouveaux  et  existants  passent  localement  avec  mes  modifications
38 ­  [ ]  Toutes  les  modifications  dépendantes  ont  été  fusionnées  et  publiées  dans  les  modules  en  aval
39

40

Exemple 3 :  modèle  de  problème  GitHub  pour  les  bogues :

1 CE  PROJET  EST  EN  MODE  MAINTENANCE.  Nous  acceptons  les  pull­requests  pour  les  corrections  de  bugs  **  UNIQUEMENT  **.  AUCUNE  NOUVELLE  FONCTIONNALITÉ  ACCEPTÉE !
2

3 <!­­­  Fournissez  un  résumé  général  de  vos  modifications  dans  le  titre  ci­dessus  ­­>
4

5 ##  Description
6 <!­­­  Décrivez  vos  modifications  en  détail  ­­>
7

8 ## Problème  connexe

9 <!­­­  Ce  projet  n'accepte  que  les  demandes  d'extraction  liées  à  des  problèmes  ouverts  ­­>
dix <!­­­  Si  vous  suggérez  une  nouvelle  fonctionnalité  ou  une  modification,  veuillez  d'abord  en  discuter  dans  un  numéro  ­­>
11 <!­­­  En  cas  de  correction  d'un  bogue,  il  devrait  y  avoir  un  problème  le  décrivant  avec  les  étapes  à  reproduire  ­­>
12 <!­­­  Veuillez  créer  un  lien  vers  le  problème  ici :  ­­>

13

14 ##  Motivation  et  contexte

15 <!­­­  Pourquoi  ce  changement  est­il  nécessaire ?  Quel  problème  résout­il ?  ­­>  <!­­­  Si  cela  résout  un  problème  
16 ouvert,  veuillez  créer  un  lien  vers  le  problème  ici.  ­­>
17

18 ##  Comment  cela  a­t­il  été  testé ?

19 <!­­­  Veuillez  décrire  en  détail  comment  vous  avez  testé  vos  modifications.  ­­>  <!­­­  Incluez  les  détails  de  
20 votre  environnement  de  test  et  les  tests  que  vous  avez  exécutés  ­­>  <!­­­  voyez  comment  votre  modification  affecte  d'autres  zones  du  
21 code,  etc.  ­­>
22

23 ##  Captures  d'écran  (le  cas  échéant) :
24

25

Exemple  4 :  Modèle  de  liste  de  contrôle  des  problèmes  GitHub

1 ###  Toutes  les  soumissions :

3 *  [ ]  Avez­vous  suivi  les  directives  de  notre  document  de  contribution ?
4 *  [ ]  Avez­vous  vérifié  qu'il  n'y  a  pas  d'autres  [Pull  Requests]  (../../../pulls)  ouvertes  pour  la  même  mise  à  jour/cha
5

6 <!­­  Vous  pouvez  effacer  toutes  les  parties  de  ce  modèle  qui  ne  s'appliquent  pas  à  votre  demande  d'extraction.  ­­>
7

8 ###  Soumissions  de  nouvelles  fonctionnalités :

dix 1.  [ ]  Votre  soumission  passe­t­elle  les  tests ?
11 2.  [ ]  Avez­vous  modifié  votre  code  localement  avant  de  le  soumettre ?
12

13 ### Modifications  des  fonctionnalités  principales :
14

15 *  [ ]  Avez­vous  ajouté  une  explication  de  l'effet  de  vos  modifications  et  de  la  raison  pour  laquelle  vous  souhaitez  que  nous  les  incluions ?
Machine Translated by Google

16 *  [ ]  Avez­vous  écrit  de  nouveaux  tests  pour  vos  modifications  principales,  le  cas  échéant ?
17 *  [ ]  Avez­vous  réussi  à  exécuter  des  tests  avec  vos  modifications  localement ?
18
19

Exemple  5 :  Liste  de  contrôle  et  questions  Modèle  de  demande  d'extraction  GitHub :

1 *  **Veuillez  vérifier  si  le  PR  remplit  ces  conditions**
2 ­  [ ]  Le  message  de  validation  suit  nos  directives
3 ­  [ ]  Des  tests  pour  les  modifications  ont  été  ajoutés  (pour  les  corrections  de  bugs/fonctionnalités)
4 ­  [ ]  Des  documents  ont  été  ajoutés/mis  à  jour  (pour  les  corrections  de  bogues/fonctionnalités)
5
6
7 *  **Quel  type  de  changement  ce  PR  introduit­il ?**  (Correction  de  bogue,  fonctionnalité,  mise  à  jour  de  la  documentation, ...)
8
9
dix
11 *  **Quel  est  le  comportement  actuel ?**  (Vous  pouvez  également  créer  un  lien  vers  un  problème  ouvert  ici)
12
13
14
15 *  **Quel  est  le  nouveau  comportement  (s'il  s'agit  d'un  changement  de  fonctionnalité) ?**
16
17
18
19 * **Cette  PR  introduit­elle  une  modification  radicale ?**  (Quelles  modifications  les  utilisateurs  doivent­ils  apporter  à  leur  application  en  raison
20
21
22
23 *  **Les  autres  informations**:
24

Exemple  6 :  Modèle  de  demande  d'extraction  GitHub  extrêmement  simple

1 Corrections  #

2
3 ##  Changements  proposés
4
5 ­

6 ­

7 ­

Exemple  7 :  Pas  de  doublon  pour  le  modèle  de  demande  d'extraction  GitHub  du  projet :

1 ##  Modèle  de  demande  d'extraction
2 Veuillez  suivre  ces  étapes  avant  de  soumettre  un  PR.
3
4 1.  Assurez­vous  que  votre  PR  n'est  pas  un  doublon.
5 2.  Si  ce  n'est  pas  le  cas,  assurez­vous  que :
6
7 un.  Vous  avez  effectué  vos  modifications  dans  une  branche  distincte.  Les  branches  DOIVENT  avoir  des  noms  descriptifs  commençant  par  eit
8
9 b.  Vous  avez  un  message  de  commit  descriptif  avec  un  titre  court  (première  ligne).
dix
Machine Translated by Google

11 c.  Vous  n'avez  qu'un  seul  commit  (sinon,  écrasez­les  en  un  seul  commit).
12

13 d.  ̀npm  test`  ne  génère  aucune  erreur.  Si  c'est  le  cas,  corrigez­les  d'abord  et  modifiez  votre  commit  (`git  commit  ­­amend
14

15 3.  **Après**  ces  étapes,  vous  êtes  prêt  à  ouvrir  une  pull  request.
16

17 un.  Votre  demande  d'extraction  NE  DOIT  PAS  cibler  la  branche  "master"  de  ce  référentiel.  Vous  voulez  probablement  cibler  ̀fe
18

19 b.  Donnez  un  titre  descriptif  à  votre  PR.
20

21 c.  Fournissez  une  description  de  vos  modifications.
22

23 d.  Mettez  ̀ferme  #XXXX`  dans  votre  commentaire  pour  fermer  automatiquement  le  problème  que  votre  PR  corrige  (le  cas  échéant).
24

25 IMPORTANT :  Veuillez  consulter  le  fichier  [CONTRIBUTING.md](../CONTRIBUTING.md)  pour  obtenir  des  instructions  détaillées  sur  les  contributions.
26

27 **VEUILLEZ  RETIRER  CE  MODÈLE  AVANT  DE  SOUMETTRE**

28