Package tidy up
clrcrl opened this issue · comments
Claire Carroll commented
Repo checklist:
Urgent:
- A
require-dbt-version
parameter in thedbt_project.yml
:
require-dbt-version: [">=0.17.0", "<0.18.0"]
- The
dbt_project.yml
is in version 2 format (upgrading docs) - Any sample
dbt_project.yml
snippets in theREADME.md
are in v2 syntax (especially for packages that usevars
- Release is of format
major.minor.patch
, e.g.1.0.0
- A license (example)
- If this package relies on dbt-utils, make sure the range allows v0.4.x
packages:
- package: fishtown-analytics/dbt_utils
version: ["???", "<0.5.0"]
Integration tests
If this package has integration tests:
- The
dbt_project.yml
of the integration tests is in v2 format - CircleCI uses python v3.6.3
- The
dbt_project.yml
does not have arequire-dbt-version
config (it should be inherited from the package)
Quick wins:
- Issue and PR templates (examples — make sure you update for the right package name)
- A codeowner (example)
- If required, a level of support header in the README
⚠️ This package is currently not actively maintained.
More in-depth improvements
- Installation instructions (see segment), including:
- Link to packages docs
- Variables that need to be included in the
dbt_project.yml
file - Listed database support
- A link to our package contribution guide (Might formalize this as a
CONTRIBUTING.md
file) - Models are documented
- Macros are documented
- Integration tests
- Move model logic intro model files, rather than entirely in adapter macros
Requires admin rights / Claire
- Repo is named
dbt-<package_name>
- The hub URL listed on the repo
Scott Vickers commented
Is there a specific reason why the dbt_utils dependency can't use version 0.5.0?