Skip to content

Commit 3169bda

Browse files
authored
Contributors shouldn't edit the CHANGELOG.md directly anymore (#240)
1 parent 6137ca6 commit 3169bda

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ See here for details for running existing integration tests and adding new ones:
6767

6868
## Adding CHANGELOG Entry
6969

70-
Unlike `dbt-core`, we edit the `CHANGELOG.md` directly.
70+
We use [automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) to generate `CHANGELOG` entries. **Note:** Do not edit the `CHANGELOG.md` directly. Your modifications will be lost.
7171

7272
You don't need to worry about which `dbt-codegen` version your change will go into. Just create the changelog entry at the top of CHANGELOG.md and open your PR against the `main` branch. All merged changes will be included in the next minor version of `dbt-codegen`. The maintainers _may_ choose to "backport" specific changes in order to patch older minor versions. In that case, a maintainer will take care of that backport after merging your PR, before releasing the new version of `dbt-codegen`.
7373

0 commit comments

Comments
 (0)