Skip to content

Commit

Permalink
[chore][CONTRIBUTING.md] Add paragraph on linking issues in PRs (#32492)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
GitHub has automation to [automatically close issues if they're prefixed
with the right
keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
It would be good to document this for users to make sure issues are
closed when the PR is merged, and not left open.
  • Loading branch information
crobert-1 authored Apr 17, 2024
1 parent 1eed25e commit bc24c22
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,22 @@ If you would like to contribute please read OpenTelemetry Collector [contributin
guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md) before you begin your
work.

## Pull-request title
## Pull-requests

### Title guidelines

The title for your pull-request should contain the component type and name in brackets, plus a short statement for your
change. For instance:

[processor/tailsampling] fix AND policy

### Description guidelines

When linking to an open issue, if your PR is meant to close said issue, please prefix your issue with one of the
following keywords: `Resolves`, `Fixes`, or `Closes`. More information on this functionality (and more keyword options) can be found
[here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
This will automatically close the issue once your PR has been merged.

## Changelog

### Overview
Expand Down

0 comments on commit bc24c22

Please sign in to comment.