-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
include directory README #4685
include directory README #4685
Conversation
Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few tiny edits and then you'll need to generate a changelog entry with changie before merging in.
@@ -0,0 +1,7 @@ | |||
kind: Docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jtcohen6 do we want Docs
to just be documentation changes generally or strictly for dbt-docs
changes?
Apart from this PR - it might be worth updating the changie README with more details on each change type (ie, be sure to add details of what will break on a breaking change).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just my opinions:
- original intent with
Docs
was "strictly for dbt-docs changes" - generally I think a change like this can be
Skip changelog
— README, reflected in GitHub only, no real change to the functionality of installeddbt-core
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was going for a changelog entry for all the things! But it makes sense that this is a good candidate for Skip Changelog
. @McKnight-42 can you make that happen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Manually deleted draft changie file and added label.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
* start of a README for the include directory * minor updates * minor updates after comments from gerda and emily * trailing space issue? * black formatting * minor word change * typo update * minor fixes and changelog creation * remove changelog
resolves #4968
Description
Writing up a README for the include directory giving brief description of each folder or file in top level.
Checklist
CHANGELOG.md
and added information about my change