File tree 2 files changed +43
-0
lines changed
2 files changed +43
-0
lines changed Original file line number Diff line number Diff line change
1
+ Git
2
+ ===
3
+
4
+ This document explains some conventions and specificities in the way we manage
5
+ the Symfony code with Git.
6
+
7
+ Pull Requests
8
+ -------------
9
+
10
+ Whenever a pull request is merged, all the information contained in the pull
11
+ request (including comments) are saved in the repository.
12
+
13
+ You can easily spot pull request merges as the commit message always follows
14
+ this pattern:
15
+
16
+ .. block: text
17
+
18
+ merged branch USER_NAME/BRANCH_NAME (PR #1111)
19
+
20
+ The PR reference allows you to have a look at the original pull request on
21
+ Github: https://github.com/symfony/symfony/pull/1111. But all the information
22
+ you can get on Github are also available from the repository itself.
23
+
24
+ The merge commit message contains the original message from the author of the
25
+ changes. Often, this can help understand what the changes were about and the
26
+ reasoning behind the changes.
27
+
28
+ Moreover, the full discussion that might have occurred back then is also
29
+ stored as a Git note (before March 22 2013, the discussion was part of the
30
+ main merge commit message). To get access to these notes, add this line to
31
+ your ``.git/config `` file:
32
+
33
+ .. block: text
34
+
35
+ fetch = +refs/notes/*:refs/notes/*
36
+
37
+ After a fetch, getting the Github discussion for a commit is then a matter of
38
+ adding ``--show-notes=github-comments `` to the ``git show `` command:
39
+
40
+ .. block: text
41
+
42
+ git show HEAD --show-notes=github-comments
Original file line number Diff line number Diff line change @@ -10,4 +10,5 @@ Contributing Code
10
10
tests
11
11
standards
12
12
conventions
13
+ git
13
14
license
You can’t perform that action at this time.
0 commit comments