Skip to content

Commit

Permalink
A few small documentation things around changelog generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
breedx-splk committed Feb 5, 2024
1 parent 45a03e6 commit 1815c3d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions .chloggen/TEMPLATE.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ component:
note:

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: []

# (Optional) One or more lines of additional information to render under the primary note.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ from `.yaml` files in the [/.chloggen](/.chloggen) directory.
Your pull request should add a new `.yaml` file to this directory.
The name of your file can be arbitrary but must be unique since the last release.

During the release process, all `./chloggen/*.yaml` files are transcribed into
During the release process, all `./.chloggen/*.yaml` files are transcribed into
`CHANGELOG.md` and then deleted.

1. Create an entry file using `make chlog-new`. The command generates a new file,
Expand Down

0 comments on commit 1815c3d

Please sign in to comment.