chore: add changelog entry to contributing md

Author: agarvin-nr

.chloggen/TEMPLATE.yaml

@@ -15,13 +15,4 @@ issues: []
 # (Optional) One or more lines of additional information to render under the primary note.
 # These lines will be padded with 2 spaces and then inserted directly into the document.
 # Use pipe (|) for multiline entries.
-subtext:
-
-# If your change doesn't affect end users or the exported elements of any package,
-# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
-# Optional: The change log or logs in which this entry should be included.
-# e.g. '[user]' or '[user, api]'
-# Include 'user' if the change is relevant to end users.
-# Include 'api' if there is a change to a library API.
-# Default: '[user]'
-change_logs: []
+subtext:

.github/workflows/changelog.yaml

@@ -1,7 +1,8 @@
 # This action requires that any PR targeting the main branch should add a
 # yaml file to the ./.chloggen/ directory. If a CHANGELOG entry is not required,
-# or if performing maintance on the Changelog, add either \"[chore]\" to the title of
-# the pull request or add the \"Skip Changelog\" label to disable this action.
+# or if performing maintenance on the Changelog, add the "Skip Changelog" label,
+# or prefix the pull request title with any of the following: "[chore]", "chore:",
+# "build:", "ci:", "docs:", "refactor:", "style:", "test:".
 
 name: changelog
 
@@ -37,7 +38,7 @@ jobs:
           PR_TITLE: ${{ github.event.pull_request.title }}
           PR_LABELS: ${{ toJSON(github.event.pull_request.labels.*.name) }}
         run: |
-          CHLOG_EXEMPT_PREFIXES=('[chore]' 'chore:' 'ci:' 'docs:')
+          CHLOG_EXEMPT_PREFIXES=('[chore]' 'chore:' 'build:' 'ci:' 'docs:' 'refactor:' 'style:' 'test:')
           for prefix in "${CHLOG_EXEMPT_PREFIXES[@]}"; do
             if [[ "$PR_TITLE" == "$prefix"* ]]; then
               echo "Title has exempt prefix '$prefix'; changelog not required."

CHANGELOG.md

@@ -1,4 +1,3 @@
 <!-- This file is autogenerated. See CONTRIBUTING.md for instructions to add an entry. -->
 
-
 <!-- next version -->

CONTRIBUTING.md

@@ -39,17 +39,30 @@ apply to specific distros.
 
 The type must be one of the following:
 
-| Type         | Description                                                   |
-|--------------|---------------------------------------------------------------|
-| **build**    | Changes that affect the build system or external dependencies |
-| **ci**       | Changes to CI configs and scripts                             |
-| **docs**     | Documentation changes                                         |
-| **feat**     | A new feature                                                 |
-| **fix**      | A bug fix related to one of the distros                       |
-| **perf**     | A performance enhancement                                     |
-| **refactor** | A code change that neither fixes a bug nor adds a feature     |
-| **style**    | Changes that effect only code style                           |
-| **test**     | Adding or updating tests                                      |
+| Type         | Description                                                   | Changelog Required |
+|--------------|---------------------------------------------------------------|--------------------|
+| **build**    | Changes that affect the build system or external dependencies | no                 |
+| **ci**       | Changes to CI configs and scripts                             | no                 |
+| **docs**     | Documentation changes                                         | no                 |
+| **feat**     | A new feature                                                 | yes                |
+| **fix**      | A bug fix related to one of the distros                       | yes                |
+| **perf**     | A performance enhancement                                     | yes                |
+| **refactor** | A code change that neither fixes a bug nor adds a feature     | no                 |
+| **style**    | Changes that effect only code style                           | no                 |
+| **test**     | Adding or updating tests                                      | no                 |
+
+### Changelog
+
+Pull requests which include user-facing changes must be accompanied by a changelog entry. This repository uses OpenTelemetry's `chloggen` tool to manage changelog entries. To make a changelog entry:
+
+1. Create an entry file using `make chlog-new`
+2. Fill in the empty fields in the new file
+3. Run `make chlog-validate` to validate the new file
+4. Commit the file with your changes
+
+If a changelog entry is not required, you may prefix your PR title with any of the conventional commit tags marked "no" in the table above, or add the `Skip Changelog` label to your pull request.
+
+During the release process, all changelog entries are transcribed in CHANGELOG.md and added to [NRDOT's release notes](https://docs.newrelic.com/docs/release-notes/nrdot-release-notes/).
 
 ## Contributor License Agreement