You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-8Lines changed: 13 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -20,17 +20,22 @@ the official [Go language](https://github.com/golang/go/pulls).
20
20
21
21
All new code is expected to be covered by tests.
22
22
23
-
#### PR Checks
23
+
#### Continuous Integration on Pull Requests
24
24
25
-
We expect all PR checks to pass before we merge a PR, which can be investigated by following the `Details` links to CircleCI and CodeCov for unit/integration tests and code coverage checks.
25
+
We expect all PR checks to pass before we merge a PR.
26
26
27
-

28
-
29
-
The code coverage report has a target of 90%. This is the goal, but is not a hard requirement. Reviewers ultimately make the decision about code coverage and quality and will merge PR's at their discretion. Any divergence from the expected 90% should be communicated by the reviewers to the PR author.
27
+
The code coverage report has a target of 90%. This is the goal, but is not a hard requirement. Reviewers ultimately make the decision about code coverage and quality and will merge PRs at their discretion. Any divergence from the expected 90% should be communicated by the reviewers to the PR author.
30
28
31
29
Please feel free to comment on a PR if there is any difficulty or confusion about any of the checks.
32
30
33
-
#### What to expect
31
+
Sometimes a pull request's checks will show failures that aren't related to its changes. When this happens, you can try the following steps:
32
+
33
+
1. look through the gitlab job logs for an obvious cause
34
+
2. retry the test a few times to see if it flakes
35
+
3. for internal contributors, ask the #dd-trace-go channel for help
36
+
4. if you are not an internal contributor, [open an issue](https://github.com/DataDog/dd-trace-go/issues/new/choose) or ping @Datadog/apm-go
37
+
38
+
#### Getting a PR Reviewed
34
39
35
40
We try to review new PRs within a week of them being opened. If more than two weeks have passed with no reply, please feel free to comment on the PR to bubble it up.
#### Favor string concatenation and string builders over fmt.Sprintf and its variants
53
58
54
-
[fmt.Sprintf](https://pkg.go.dev/fmt#Sprintf) can introduce unnecessary overhead when building a string. Favor [string builders](https://pkg.go.dev/strings#Builder), or simple string concatenation, `a + "b" + c` over `fmt.Sprintf` when possible, especially in hot paths.
59
+
[fmt.Sprintf](https://pkg.go.dev/fmt#Sprintf) can introduce unnecessary overhead when building a string. Favor [string builders](https://pkg.go.dev/strings#Builder), or simple string concatenation, `a + "b" + c` over `fmt.Sprintf` when possible, especially in hot paths.
0 commit comments