@@ -12,7 +12,10 @@ To propose improvements, feel free to submit a PR.
12
12
* [ Pull Requests] ( #pull-requests )
13
13
- [Keep it small, focused](#keep-it-small-focused)
14
14
- [Commit Messages](#commit-messages)
15
- - [Squash your commits](#squash-your-commits)
15
+ - [Pull request workflow](#pull-request-workflow)
16
+ + [Before the first PR review](#before-the-first-pr-review)
17
+ + [After the first review](#after-the-first-review)
18
+ + [How to merge to `main`](#how-to-merge-to-main)
16
19
- [Reno](#reno)
17
20
+ [Reno sections](#reno-sections)
18
21
* [ PR labels] ( #pr-labels )
@@ -22,10 +25,9 @@ To propose improvements, feel free to submit a PR.
22
25
23
26
## Submitting issues
24
27
25
- * If you think you've found an issue, please search the [ Troubleshooting] [ troubleshooting ]
26
- section of our [ Knowledge base] [ kb ] to see if it's known.
27
- * If you can't find anything useful, please contact our [ support] [ support ] and
28
- [ send them your logs] [ flare ] .
28
+ * If you think you've found an issue, please search the [ Agent Troubleshooting] [ troubleshooting ]
29
+ section to see if it's known.
30
+ * If you’re still unsure about the issue, you may reach out to the [ Datadog support] [ support ] team with [ a flare] [ flare ] from your Agent.
29
31
* Finally, you can open a Github issue.
30
32
31
33
## Pull Requests
@@ -35,7 +37,7 @@ Have you fixed a bug or written a new check and want to share it? Many thanks!
35
37
In order to ease/speed up our review, here are some items you can check/improve
36
38
when submitting your PR:
37
39
38
- * have a [ proper commit history] ( #commits ) (we advise you to rebase if needed).
40
+ * have a proper commit history (we advise you to rebase if needed).
39
41
* write tests for the code you wrote.
40
42
* preferably make sure that all tests pass locally.
41
43
* summarize your PR with an explanatory title and a message describing your
@@ -44,11 +46,11 @@ when submitting your PR:
44
46
* open your PR against the ` main ` branch.
45
47
* for PRs from contributors with write access to the repository (for community PRs, will be done by Datadog employees):
46
48
+ set the relevant ` team/ ` label
47
- + add a milestone to your PR (by default, use the highest milestone version available, ex: ` 6.8 .0` )
49
+ + add a milestone to your PR (by default, use the highest milestone version available, ex: ` 7.49 .0` )
48
50
49
51
Your pull request must pass all CI tests before we will merge it. If you're seeing
50
52
an error and don't think it's your fault, it may not be! [ Join us on Slack] [ slack ]
51
- or send us an email, and together we'll get it sorted out.
53
+ or [ send us an email] [ email ] , and together we'll get it sorted out.
52
54
53
55
### Keep it small, focused
54
56
@@ -95,7 +97,7 @@ The goals ordered by priority are:
95
97
- Make PR reviews (both initial and follow-up reviews) easy for reviewers using
96
98
GitHub
97
99
- On the ` main ` branch, have a meaningful commit history that allows
98
- understanding (even years later) what each commit does, and why.
100
+ understanding (even years later) what each commit does, and why.
99
101
100
102
You must open the PR when the code is reviewable or you must set the PR as
101
103
draft if you want to share code before it's ready for actual reviews.
@@ -121,10 +123,10 @@ Once reviews are complete, the merge to `main` should be done with either:
121
123
- the squash-merge option, to keep the history of ` main ` clean (even though
122
124
some context/details are lost in the squash). The commit message for this
123
125
squash should always be edited to concisely describe the commit without
124
- extraneous “address review comments” text.
126
+ extraneous “address review comments” text.
125
127
- the “rebase-merge” option, after manually rewriting the PR’s commit history
126
128
and force-pushing to the branch. When using this option, the branch must have
127
- a clean history.
129
+ a clean history.
128
130
129
131
### Reno
130
132
@@ -270,10 +272,11 @@ or review the latest changes. For new integrations, please open a pull request
270
272
in the [integrations-extras][extras] repo.
271
273
272
274
273
- [troubleshooting] : https://help .datadoghq.com/
275
+ [troubleshooting] : https://docs .datadoghq.com/agent/troubleshooting /
274
276
[kb] : https://datadog.zendesk.com/hc/en-us
275
- [support] : http ://docs.datadoghq.com/help/
276
- [flare] : https://github. com/DataDog/dd- agent/wiki/Send-logs-to-support
277
+ [support] : https ://docs.datadoghq.com/help/
278
+ [flare] : https://docs.datadoghq. com/agent/troubleshooting/send_a_flare/
277
279
[extras] : https://github.com/DataDog/integrations-extras
278
280
[core] : https://github.com/DataDog/integrations-core
279
- [slack] : http://datadoghq.slack.com
281
+ [slack] : https://chat.datadoghq.com/
282
+
0 commit comments