Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Doug Beatty <[email protected]>
  • Loading branch information
joellabes and dbeatty10 authored Jul 29, 2022
1 parent e8f3e82 commit 111315e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions package-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S

### First run experience
- Packages SHOULD contain a README file which explains how to get started with the package and customise its behaviour.
- The documentation SHOULD indicate which data warehouses are expected to work with this package.

### Customisability
- Packages MUST NOT hard-code table references, and MUST use `ref` or `source` instead.
Expand All @@ -37,5 +38,6 @@ Packages with a dependency on another package:
- Packages SHOULD disambiguate their resource names to avoid clashes with nodes that are likely to already exist in a project.
- For example, packages SHOULD NOT provide a model simply called `users`.

### Updates
- Packages SHOULD follow the guidance of the [Semantic Versioning Specification](https://semver.org/).
### Releases and updates
- Packages SHOULD follow the guidance of the [Semantic Versioning Specification](https://semver.org/).
- Packages MUST create a git tag with the version number that follows the accepted version format.

0 comments on commit 111315e

Please sign in to comment.