Projet

Général

Profil

Révision 1f5f70ef

ID1f5f70ef5a09933fb88dbfca9cfb8915109e6eff
Parent 803ad3b3
Enfant a6a1ee1d

Ajouté par Steve Schnepp il y a presque 11 ans

README: Add some precision to the commit message

Voir les différences:

README.md
36 36 

  		




  37
  37
  
    
### Commits, Comments & Pull requests


  		




  38
  38
  
    

  		




  39
  
  
    
We like to have ''elementary'' commits as it is much easier to manage for reviewing and debugging. 


  		




  
  39
  
    
We like to have _elementary_ commits as it is much easier to manage for reviewing and debugging. 


  		




  40
  40
  
    
So please **don't** be afraid to make **as many** commits as needed. Merging many commits is as easy


  		




  41
  41
  
    
as merging one, if not easier.


  		




  42
  42
  
    

  		




  43
  43
  
    
A good rationale is that each commit shall have a one-liner commit comment as its first line. 


  		




  44
  
  
    
Next lines are optional and should only explain the ''why'' it is done this particular way.


  		




  
  44
  
    
Ideally that first line has a prefix that shows the part the commit is about. It makes it very


  		




  
  45
  
    
easy to see grouped changes, and it enable avoiding to look at the --stat. To know the prefix you should


  		




  
  46
  
    
use, you can have a look at already existing commits. Next lines are optional and should only


  		




  
  47
  
    
explain the _why_ it is done this particular way. 


  		




  45
  48
  
    

  		




  46
  49
  
    
On the other side, pull requests can regroup many commits at once.


  		




  47
  50
  
    
Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious).


  		












Formats disponibles :  Unified diff