-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Craft a solution for a 'centralized' changelog for the fuels
package
#970
Labels
chore
Issue is a chore
Comments
The changelog should just reference the GitHub releases page, which has the best source of truth and is automated: |
I agree, but I also like the idea of a consolidated Changelog. Perhaps a combination of all could involve:
|
This was referenced May 29, 2023
This should be automatically resolved by: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently, the
CHANGELOG.md
at the root of our project is a symlink that points to theCHANGELOG.md
file inside of thefuels
package. Apart from the fact that GitHub does not handle symlinks properly, and instead shows this:... the
CHANGELOG.md
file inside thefuels
package also does not contain all the changes that are incorporated in our codebases. It only includes information about version bumps to other packages.Ideally, we should have a
CHANGELOG.md
file at the root of the repo where we append any and all the changes we add to any of the child packages' changelogs.The motivation behind this is to make it easy for SDK users to browse through our version history and see what changes happened when.
The text was updated successfully, but these errors were encountered: