search

bratislava / bratislava.github.io

Our docs pages made in Nextra
https://bratislava.github.io
MIT License
2 stars 1 forks source link

Referencovanie issues v commit messages #48

Open Balros opened 4 months ago

Balros commented 4 months ago

Suggesting to add reference on issue inside commit message, which this commit/PR is solving:

  1. reference to issue which this commit/PR is solving this will automatically add link to issue inside commit message and also the other way, it will add link inside issue to this commit/PR.
    • #47 - referencing isssue that is in same repository as commit/PR is
    • bratislava/private-maps#16 - when referencing issue that is located in different repository as commit/PR
  2. based on previous point, if we are going to reference issues with help of # character and this character is located at start of line, it will cause another issue, the line will be treated as comment and it will be ignored. Common solution is to wrap reference inside square brackets -> [#46] [bratislava/private-maps#13]

    Please enter the commit message for your changes. Lines starting with '#' will be ignored, and an empty message aborts the commit.

Sidenote, when Pull Requests is created it will automatically take message from first commit and use it in PR message, where references also works.