Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the changelog template #28

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the changelog template #28

wants to merge 1 commit into from

Conversation

yhaliaw
Copy link

@yhaliaw yhaliaw commented Mar 6, 2025

Applicable spec:

Overview

Updated the changelog template

Rationale

The previous Checklist was not clear on:

  • Where the changelog is located
  • What type of changes should be recorded
  • What is the format of the changelog

Checklist

  • The charm style guide was applied
  • The contributing guide was applied
  • The changes are compliant with ISD054 - Managing Charm Complexity
  • The documentation is generated using src-docs
  • The documentation for charmhub is updated
  • The PR is tagged with appropriate label (urgent, trivial, senior-review-required, documentation)
  • The changelog is updated.

@yhaliaw yhaliaw requested a review from a team as a code owner March 6, 2025 02:10
@yhaliaw yhaliaw requested review from weiiwang01 and DeeKay3 March 6, 2025 02:10
Copy link

github-actions bot commented Mar 6, 2025

Test results for commit 1551697

Test coverage for 1551697

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py      31      0      4      0   100%
----------------------------------------------------------
TOTAL             31      0      4      0   100%

Static code analysis report

Run started:2025-03-06 02:12:30.957979

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 151
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

Copy link
Member

@yanksyoon yanksyoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would adding the initial changelog be good here? (or appending this change to the changelog?)

@@ -28,6 +28,6 @@ Applicable spec: <link>
- [ ] The documentation is generated using `src-docs`
- [ ] The documentation for charmhub is updated
- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `senior-review-required`, `documentation`)
- [ ] The changelog is updated.
- [ ] The `docs/changelog.md` is updated with user-relevant changes.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if it would work: maybe you could directly create a link to the changelog?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants