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.

Sign up for GitHub

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

Jump to bottom

Add style guide #3300

Merged
merged 29 commits into from
Jul 5, 2023
Merged

Add style guide #3300

merged 29 commits into from
Jul 5, 2023

Conversation

gwenwindflower
Copy link
Contributor

@gwenwindflower gwenwindflower commented Apr 27, 2023 •
edited
Loading

What are you changing in this pull request and why?

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

@netlify
Copy link

netlify bot commented Apr 27, 2023 •
edited
Loading

✅ Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 7ffff15
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64a5b0e675f5970008ba4367
😎 Deploy Preview https://deploy-preview-3300--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides size: large This change will more than a week to address and might require more than one person labels Apr 27, 2023
wasilaq
wasilaq reviewed May 2, 2023
View reviewed changes
Copy link

@wasilaq wasilaq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really love this! It'll be nice to have a style guide that's cleaned up and distinct from the project structure guide.

website/docs/guides/best-practices/how-we-style/0-how-we-style-our-dbt-projects.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/0-how-we-style-our-dbt-projects.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/4-how-we-style-our-jinja.md Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md Show resolved Hide resolved
@gwenwindflower gwenwindflower marked this pull request as ready for review June 23, 2023 13:50
@gwenwindflower gwenwindflower requested a review from a team as a code owner June 23, 2023 13:50
joellabes
joellabes reviewed Jun 26, 2023
View reviewed changes
website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md
## Fields and model names

- 👥 Models should be pluralized, e.g. `customers`, `orders`, `products`.
- 🔑 Each model should have a primary key.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have opinions about whether this is a single column (implying dbt_utils.generate_surrogate_key(['region_id', 'user_id'])) or are you OK with the two columns region_id + user_id fulfilling this duty between them?

website/docs/guides/best-practices/how-we-style/1-how-we-style-our-dbt-models.md Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/3-how-we-style-our-python.md Outdated
@@ -0,0 +1,39 @@
---
title: How we style our python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this lowercase python a specific choice? everywhere else it's capitalised but as the lowercase-your-proper-nouns company, I'm loath to immediately label this a typo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good q -- @matthewshaver what's our official style stance here do we capitalize python?

website/docs/guides/best-practices/how-we-style/4-how-we-style-our-jinja.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/5-how-we-style-our-yaml.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/6-how-we-style-conclusion.md Outdated Show resolved Hide resolved
website/docs/guides/best-practices/how-we-style/6-how-we-style-conclusion.md Outdated Show resolved Hide resolved
website/sidebars.js Show resolved Hide resolved
@gwenwindflower gwenwindflower enabled auto-merge (squash) July 5, 2023 18:06
jasnonaz
jasnonaz approved these changes Jul 5, 2023
View reviewed changes
Copy link
Contributor

@jasnonaz jasnonaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s t y l e

@gwenwindflower gwenwindflower merged commit 64effdf into current Jul 5, 2023
@gwenwindflower gwenwindflower deleted the add-style-guide branch July 5, 2023 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wasilaq wasilaq wasilaq left review comments

@matthewshaver matthewshaver matthewshaver left review comments

@joellabes joellabes joellabes left review comments

@jasnonaz jasnonaz jasnonaz approved these changes

Assignees
No one assigned
Labels
content Improvements or additions to content guides Knowledge best suited for Guides size: large This change will more than a week to address and might require more than one person
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gwenwindflower @joellabes @jasnonaz @matthewshaver @wasilaq