Skip to content

Commit 02436a7

Browse files
authored
[chore] Fix header levels of makefile guidelines in CONTRIBUTING.md (open-telemetry#29453)
**Documentation:** <Describe the documentation added.> Upon review, the `Makefile Guidelines` section (and its own subsections) is under the `Becoming a Code Owner` section. This is not correct, so this change moves the `Makefile Guidelines` section to be directly underneath the top level `Contributing` header.
1 parent 17b2130 commit 02436a7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ Code Ownership is ultimately up to the judgement of the existing Code Owners and
380380
To become a Code Owner, open a PR adding your GitHub username to the active codeowners entry in the component's `metadata.yaml` file.
381381
Be sure to tag the existing Code Owners, if any, within the PR to ensure they receive a notification.
382382
383-
### Makefile Guidelines
383+
## Makefile Guidelines
384384
385385
When adding or modifying the `Makefile`'s in this repository, consider the following design guidelines.
386386
@@ -389,7 +389,7 @@ The [Makefile](./Makefile) SHOULD contain "repo-level" targets. (i.e. targets th
389389
Likewise, `Makefile.Common` SHOULD contain "module-level" targets. (i.e. targets that apply to one module at a time.)
390390
Each module should have a `Makefile` at its root that includes `Makefile.Common`.
391391
392-
#### Module-level targets
392+
### Module-level targets
393393
394394
Module-level targets SHOULD NOT act on nested modules. For example, running `make lint` at the root of the repo will
395395
*only* evaluate code that is part of the `go.opentelemetry.io/collector` module. This excludes nested modules such as
@@ -399,7 +399,7 @@ Each module-level target SHOULD have a corresponding repo-level target. For exam
399399
in each module. In this way, the entire repository is covered. The root `Makefile` contains some "for each module" targets
400400
that can wrap a module-level target into a repo-level target.
401401
402-
#### Repo-level targets
402+
### Repo-level targets
403403
404404
Whenever reasonable, targets SHOULD be implemented as module-level targets (and wrapped with a repo-level target).
405405
However, there are many valid justifications for implementing a standalone repo-level target.
@@ -409,7 +409,7 @@ However, there are many valid justifications for implementing a standalone repo-
409409
3. A necessary tool does not provide a mechanism for scoping its application. (e.g. `porto` cannot be limited to a specific module.)
410410
4. The "for each module" pattern would result in incomplete coverage of the codebase. (e.g. A target that scans all file, not just `.go` files.)
411411
412-
#### Default targets
412+
### Default targets
413413
414414
The default module-level target (i.e. running `make` in the context of an individual module), should run a substantial set of module-level
415415
targets for an individual module. Ideally, this would include *all* module-level targets, but exceptions should be made if a particular

0 commit comments

Comments
 (0)