@@ -25,3 +25,84 @@ are up to date.
25
25
26
26
Carson will never read the contents of a pull requests, ie it never parses the code
27
27
to check for typos or other automated fixes.
28
+
29
+ ## Features
30
+
31
+ Here is all the things Carson can help you with. Not all features are enabled. A
32
+ list of enabled features for a specific repository is defined in ` config/services.yaml ` .
33
+
34
+ ### Automatic labeling from content
35
+
36
+ Using the issue template, Carson adds labels "Bug", "Feature", "BC Break"
37
+ and "Deprecation" on issues and pull requests.
38
+
39
+ ### Add "Needs Review" label on pull requests
40
+
41
+ When a PR is opened, then Carson will add "Needs Review".
42
+
43
+ ### Add "Needs Review" label on bugs issues
44
+
45
+ If an issue is labeled with "Bug", then Carson will add "Needs Review".
46
+
47
+ ### Update pull request title with component labels
48
+
49
+ When a PR is labeled, Carson looks for component labels (i.e. labels with color #dddddd).
50
+ These labels' names will be added to the PR title (e.g. ` [HttpKernel] ` ).
51
+
52
+ ### Close draft pull requests
53
+
54
+ When a PR is open as "draft", Carson adds a comment to encourage people to mark it as
55
+ "ready to review". If no action is taken, Carson will close the PR in one hour.
56
+
57
+ ### Add milestone to PRs
58
+
59
+ When a new PR is opened and it does not target the default branch or current version, then
60
+ Carson will update the milestone of the PR to a existing milestone that matches the target branch.
61
+
62
+ ### Manage pull request status
63
+
64
+ The "status" of a pull request defined by one of the labels: "Needs review", "Needs work",
65
+ "Works for me" and "Reviewed". The status can be changed by adding a comment like:
66
+ "Status: needs work".
67
+
68
+ The status will also be changed if someone adds a review that requests changes or
69
+ approves the PR. Finally, the status will be "Needs review" after the author pushes
70
+ changes to the PR.
71
+
72
+ ### Welcome new contributors
73
+
74
+ When a user opens their first PR, they will get a welcome message explaining the
75
+ review process and how to increase the chances to get the PR merged.
76
+
77
+ ### Comment on stale issues
78
+
79
+ Carson will look for old inactive issues and start a process with them.
80
+
81
+ 1 . Bot will make a comment to encourage activity and add label "Staled".
82
+ 1 . Bot will make a comment to inform the issue will be closed
83
+ 1 . Bot will close the issue.
84
+
85
+ The process can be interrupted with anyone making a comment on the issue or the
86
+ "Keep open" label is added.
87
+
88
+ ### Suggest reviewers
89
+
90
+ Carson can look at the PR to figure out who will be a good candidate to review the
91
+ changes. This can be triggered by someone can make a comment in a PR to say
92
+ ` @carsonbot find me a reviewer please ` (or really anything with ` @carsonbot ` and
93
+ ` review ` on the same line).
94
+
95
+ Carson will also try to find a reviewer if there is no activity on a new PR within
96
+ the first 20 hours.
97
+
98
+ ### Add a warning if pull request target unsupported branch
99
+
100
+ If a PR is opened towards a branch that is not maintained anymore, Carson will
101
+ kindly explain to the author what to do.
102
+
103
+ ### Open issues when docs for config reference is incomplete
104
+
105
+ The Symfony documentation includes some pages with "configuration reference", to
106
+ make sure these are always up to date, Carson will look at the bundles' defined
107
+ config and compare that to what is documented. If Carson finds something that is
108
+ missing, it will open an issue in the symfony/symfony-docs repository.
0 commit comments