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

Create a changelog.md file #209

Open
RobotSail opened this issue Sep 13, 2024 · 0 comments
Open

Create a changelog.md file #209

RobotSail opened this issue Sep 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@RobotSail
Copy link
Member

When we issue new releases today, we typically just generate the release notes. But this doesn't paint the best picture when describing new features, improvements, and issues when we generate the release notes. And it's unrelealistic to expect the releaser to fully understand what each change enables, its implications, and how to best describe examples.

For this reason, we should adopt a changelog.md file as already exists in the CLI repo

@nathan-weinberg nathan-weinberg added the documentation Improvements or additions to documentation label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants