Skip to content

Conversation

@prapulkrishna-shaik
Copy link

Description:

Related issue(s):

Fixes #

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Signed-off-by: prapulkrishna-shaik <shaikprapul4@gmail.com>
@prapulkrishna-shaik prapulkrishna-shaik force-pushed the docs/changelog-guidelines-461 branch from d65e2de to 06616d3 Compare October 20, 2025 16:23
@prapulkrishna-shaik prapulkrishna-shaik changed the title Docs: Create changelog guidelines (Closes #461) docs: Create changelog guidelines (Closes #461) Oct 20, 2025
@prapulkrishna-shaik
Copy link
Author

Description:
Creates a new changelog guidelines document in docs/sdk_developers/ and links to it from the CONTRIBUTING.md file.

Related issue(s):
Closes #461

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

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

Hi @prapulkrishna-shaik
Unfortunately, I cannot see any change to your changelog.md file, it is blank, did you intend to add content to it?

i realise I was not clear in the issue
To close the issue, changelog.md should explain to users the following:

It should link the issue solved by their pull request

Clear language but descriptive language. For example, try to avoid eg "refactored token create", instead say eg "refactored keys in token_create to avoid harcoding"

1-2 sentences.

Add their entry to the top of the file, under unreleased.

Explain to them what the unreelased sections mean, like fixed, added and changed and how to decide where theirs best fits.

We should provide good examples of changelog entries.

@exploreriii
Copy link
Contributor

hi @prapulkrishna-shaik is still ongoing? This is a really important issue that we need resolved

@exploreriii
Copy link
Contributor

Hi @prapulkrishna-shaik I am closing this PR and re-assigning as it seems it is no longer being worked on after asking twice.
Please do feel free to have a go at any other issue!
Thank you so much and apologies for the inconvenience

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.

2 participants