Skip to content

Suggestions for Documentation #12

@jackzheng-cs

Description

@jackzheng-cs

Reason for making change?
Suggestions for Documentation after first Pull Request for the Alert component.

What file or part of documentation?

  • FIRST-TICKET.md
  • CONTRIBUTING.md

Additional context

  • In FIRST-TICKET.md add:

When testing in app/test/pages.tsx, put your code inside export default function TestPage(){...} and go to local host:3000/test on your browser. Your code should look similar to:

export default function TestPage() {
    const variants = [
        // Your component variants
    ] as const;
        // Your component sizes
    const sizes = ["default"] as const;

    return (
        // Implement your component
);
}
  • In FIRST-TICKET.md under Claimed Ticket. What Now? add:

Request for Figma file access so developers can use Figma dev mode.

  • In FIRST-TICKET.md under Implementation bold or add symbol for very important to the line:

Before you begin, check the ShadCN Website to see if the component already exists. If it does, use it as your starting point. If not, create a new component. Remember: The core functionality of ShadCN components must remain unchanged—only the design should be updated.

  • In CONTRIBUTING.md add:

Be sure to fork codelab-ui-components repo first, make a branch there, and then make a PR using your forked branch.

  • In CONTRIBUTING under format code add:

If there are any file changes after prettier format, still commit.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions