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.

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

[CT-3477] [OSS] OSS Standardization #9252

Closed
1 task done
emmyoop opened this issue Dec 7, 2023 · 1 comment · Fixed by #9316
Closed
1 task done

[CT-3477] [OSS] OSS Standardization #9252

emmyoop opened this issue Dec 7, 2023 · 1 comment · Fixed by #9316
Assignees
Labels
tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality

Comments

@emmyoop
Copy link
Member

emmyoop commented Dec 7, 2023

Housekeeping

  • I am a maintainer of dbt-core

Short description

As part of #9221, there have been a few changes to how we want to format docs/templates in our OSS repos.

  1. .github/TEMPLATES
  2. CONTRIBUTING.md
    • Add troubleshooting section to the bottom similar to the template in dbt-docs here
    • Remove mention of Jira - we don't use it for dbt-core anymore
    • We don't have integration tests anymore, so remove their mention here
  3. README.md
    • Update the following line
Want to report a bug or request a feature? Let us know on [Slack](http://community.getdbt.com/), or open [an issue](https://github.com/dbt-labs/dbt-core/issues/new)

to

Want to report a bug or request a feature? Let us know and open [an issue](https://github.com/dbt-labs/dbt-core/issues/new/choose)

Acceptance criteria

The docs in this repo meet the same formatting standards as dbt-oss-template

Impact to Other Teams

None, this is just a docs change

Will backports be required?

Nope

Context

Any other changes to make it easier for contributors would be welcome!

@emmyoop emmyoop added the tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality label Dec 7, 2023
@github-actions github-actions bot changed the title [OSS] OSS Standardization [CT-3477] [OSS] OSS Standardization Dec 7, 2023
@Tonayya Tonayya linked a pull request Dec 25, 2023 that will close this issue
5 tasks
@Tonayya Tonayya mentioned this issue Dec 27, 2023
5 tasks
@Tonayya
Copy link
Contributor

Tonayya commented Dec 28, 2023

PR for issue.
Hey @emmyoop with issue 2, is there actually any troubleshooting steps I can add to this new section, or are we just creating the section and leaving blank? With removal of mention of JIRA, this was for the branch naming convention for internal contributors that said to use CT-XXXX, whats the replacement for this? Should I just say use your initials?
Edit: just removed this bit entirely "Branch names should be fixed by CT-XXX/ where:

  • CT stands for 'core team'
  • XXX stands for a JIRA ticket number"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants