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

Contributors shouldn't edit the CHANGELOG.md directly anymore #237

Closed
dbeatty10 opened this issue Dec 13, 2024 · 0 comments · Fixed by #240
Closed

Contributors shouldn't edit the CHANGELOG.md directly anymore #237

dbeatty10 opened this issue Dec 13, 2024 · 0 comments · Fixed by #240
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dbeatty10
Copy link
Contributor

Describe the documentation change

We should clarify within our contributing guide that users should not make modifications to CHANGELOG.md anymore, because they will be overwritten during the release process.

While dbt-codegen does not use changie like dbt-core, et al. it also doesn't need manual updating by users anymore.

The implementation can use dbt-core or dbt-snowflake for inspiration.

Additional context

This is the same thing as dbt-labs/dbt-utils#914, but applied to the dbt-codegen repo.

Who will this benefit?

This will benefit contributors and maintainers -- less to do all-around.

@dbeatty10 dbeatty10 added enhancement New feature or request triage documentation Improvements or additions to documentation and removed triage labels Dec 13, 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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant