Projet

Général

Profil

Révision 8f26c533

ID8f26c533bc46dd71de0a65396cc445d8a2d1bcd7
Parent 0df18b53
Enfant e6ece317

Ajouté par Steve Schnepp il y a plus de 13 ans

Expanded the commit comments rationale

Voir les différences:

README.md
34 34 

  		




  35
  35
  
    
## Notes to contributors


  		




  36
  36
  
    

  		




  37
  
  
    
We like to have ''elementary'' commits (a good rationale is : one per Changelog entry), as it is much easier to manage for reviewing. Debugging is also usually easier that way.


  		




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


  		




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


  		




  
  39
  
    
as merging one, if not easier.


  		




  
  40
  
    

  		




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


  		




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


  		




  
  43
  
    

  		




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


  		




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


  		




  38
  46
  
    

  		




  39
  
  
    
So please **don't** be afraid to make as many commits as needed.


  		












Formats disponibles :  Unified diff