Skip to content

Commit 7979e6c

Browse files
authored
Update contributing file (DataDog#20923)
1 parent a2ef092 commit 7979e6c

File tree

3 files changed

+19
-21
lines changed

3 files changed

+19
-21
lines changed

docs/dev/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide will help you to develop and contribute code to the project.
44

5-
## TOC
5+
## Table of Content
66

77
* [Custom checks developer guide](checks/README.md)
88
* [Python builtin modules](checks/builtins)

docs/dev/agent_dev_env.md

-5
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,6 @@ also any additional python dependencies our development workflow may require,
9090
at their expected versions.
9191
It will also pull other handy development tools/deps (`reno`, or `docker`).
9292

93-
Tasks are usually parameterized and Invoke comes with some default values that
94-
are used in the official build. Such values are listed in the `invoke.yaml`
95-
file at the root of this repo and can be overridden by setting `INVOKE_*` env
96-
variables (see Invoke docs for more details).
97-
9893
### Golang
9994

10095
You must [install Golang](https://golang.org/doc/install) version `1.20.11` or

docs/dev/contributing.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ To propose improvements, feel free to submit a PR.
1212
* [Pull Requests](#pull-requests)
1313
- [Keep it small, focused](#keep-it-small-focused)
1414
- [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)
1619
- [Reno](#reno)
1720
+ [Reno sections](#reno-sections)
1821
* [PR labels](#pr-labels)
@@ -22,10 +25,9 @@ To propose improvements, feel free to submit a PR.
2225

2326
## Submitting issues
2427

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.
2931
* Finally, you can open a Github issue.
3032

3133
## Pull Requests
@@ -35,7 +37,7 @@ Have you fixed a bug or written a new check and want to share it? Many thanks!
3537
In order to ease/speed up our review, here are some items you can check/improve
3638
when submitting your PR:
3739

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).
3941
* write tests for the code you wrote.
4042
* preferably make sure that all tests pass locally.
4143
* summarize your PR with an explanatory title and a message describing your
@@ -44,11 +46,11 @@ when submitting your PR:
4446
* open your PR against the `main` branch.
4547
* for PRs from contributors with write access to the repository (for community PRs, will be done by Datadog employees):
4648
+ 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`)
4850

4951
Your pull request must pass all CI tests before we will merge it. If you're seeing
5052
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.
5254

5355
### Keep it small, focused
5456

@@ -95,7 +97,7 @@ The goals ordered by priority are:
9597
- Make PR reviews (both initial and follow-up reviews) easy for reviewers using
9698
GitHub
9799
- 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.
99101

100102
You must open the PR when the code is reviewable or you must set the PR as
101103
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:
121123
- the squash-merge option, to keep the history of `main` clean (even though
122124
some context/details are lost in the squash). The commit message for this
123125
squash should always be edited to concisely describe the commit without
124-
extraneous “address review comments” text.
126+
extraneous “address review comments” text.
125127
- the “rebase-merge” option, after manually rewriting the PR’s commit history
126128
and force-pushing to the branch. When using this option, the branch must have
127-
a clean history.
129+
a clean history.
128130

129131
### Reno
130132

@@ -270,10 +272,11 @@ or review the latest changes. For new integrations, please open a pull request
270272
in the [integrations-extras][extras] repo.
271273

272274

273-
[troubleshooting]: https://help.datadoghq.com/
275+
[troubleshooting]: https://docs.datadoghq.com/agent/troubleshooting/
274276
[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/
277279
[extras]: https://github.com/DataDog/integrations-extras
278280
[core]: https://github.com/DataDog/integrations-core
279-
[slack]: http://datadoghq.slack.com
281+
[slack]: https://chat.datadoghq.com/
282+
[email]: mailto:[email protected]

0 commit comments

Comments
 (0)