Skip to content

Start CHANGELOG#85

Merged
micah-prime merged 1 commit into
masterfrom
changelog
Aug 8, 2024
Merged

Start CHANGELOG#85
micah-prime merged 1 commit into
masterfrom
changelog

Conversation

@jomey
Copy link
Copy Markdown
Member

@jomey jomey commented Jul 5, 2024

Going forward, we should use this to create a list of PRs that introduce new/breaking changes to the codebase.

Alternatively, we could look into using this GitHub feature?
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Looks promising and would save us from manually maintaining this?

Side note:

In a next PR, I want to add a CONTRIBUTION.md
Do you guys have a template for that?
Otherwise I would start looking for one

Going forward, we should use this to create a list of PRs that introduce new/breaking changes to the codebase.
Copy link
Copy Markdown
Contributor

@micah-prime micah-prime left a comment

Choose a reason for hiding this comment

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

Nice! I love the idea of auto-generated release notes. My vote would be to go that direction.

Good call on the CONTRIBUTING.md - we could make minor changes to the metloom one that I think would cover our bases
https://github.com/M3Works/metloom/blob/main/CONTRIBUTING.rst

@jomey
Copy link
Copy Markdown
Member Author

jomey commented Jul 8, 2024

Good call on the CONTRIBUTING.md - we could make minor changes to the metloom one that I think would cover our bases
https://github.com/M3Works/metloom/blob/main/CONTRIBUTING.rst

That guide looks great. I will tackle that in a next PR to adapt to here

@jomey
Copy link
Copy Markdown
Member Author

jomey commented Jul 23, 2024

Noting that there is a docs/history.rst that needs to be updated with this PR as well

@jomey jomey mentioned this pull request Aug 1, 2024
@micah-prime micah-prime merged commit fb5d25a into master Aug 8, 2024
@micah-prime micah-prime deleted the changelog branch August 8, 2024 17:03
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