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

feat: Add quick start section #203

Open
wants to merge 2 commits into
base: beta
Choose a base branch
from
Open

feat: Add quick start section #203

wants to merge 2 commits into from

Conversation

BekahHW
Copy link
Member

@BekahHW BekahHW commented Sep 19, 2024

Description

Adds a quickstart guide to walk users through using the pizza-cli for their project. This includes adding a config and codeowners, generating insights and adding the GH action.

Related Tickets & Documents

closes #202

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] What gif best describes this PR or how it makes you feel?

@BekahHW BekahHW requested a review from a team September 19, 2024 15:49
README.md Outdated Show resolved Hide resolved

In your project directory, run:
```sh
npx pizza@latest generate codeowners .
Copy link
Member

Choose a reason for hiding this comment

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

For consistency, do you want . or ./?

Suggested change
npx pizza@latest generate codeowners .
npx pizza@latest generate codeowners ./

@nickytonline nickytonline dismissed zeucapua’s stale review September 19, 2024 20:43

Dismissing Zeu's review as she's in vacation and the changes have been made

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add a quickstart guide to the readme
4 participants