Skip to content

Squash and Merge PR Messages

Jump to bottom
Mostafa Jahanifar edited this page Feb 17, 2021 · 1 revision

Merging is essentially creating a new commit which incorporates changes from two branches. As such, normal commit message formatting guidelines apply.

Some additional structure is useful here to note that this commit is the result of a merge and to refer to the pull request (PR) that it came from.

Template 

Title on the first line if doing from the command line

(On GitHub make sure you are writing in the correct section for title.)

Merge pull request #123 from

Description of the features added. Summary of all of the commits which are being squashed into one.

  • Can use bullet points by using a dash or asterisks. Prefer dashes for consistency with other commits.

  • Remember to write in the imperative and use a full stop here.

Example

ENH: Add Feature To Read Slide Meta Data

Merge pull request #1 from feature-slide-info

Add Feature slide-info

  • Add WSIReader class to read whole slide images. Currently this class is using openslide and therefore can only read file formats supported by openslide.

  • Add slide_info function which returns slide meta information.

  • Add TIAMultiProcess decorator to run functions using multiple cores.

  • Add misc to write miscellaneous small functions repeatedly required for use in the repo.

 

 

 

 

 

 

Clone this wiki locally