Skip to content

Commit

Permalink
docs: updated contributing guidelines to easily contribute (#1830)
Browse files Browse the repository at this point in the history
## Explanation
Added detailed info to clone and setup the project to contribute.

Following the PR #1650 and suggestion of @shadcn.  Thanks!
  • Loading branch information
william-monroy authored Nov 12, 2023
1 parent a2ed288 commit 53f211b
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,31 @@ packages

## Development

### Start by cloning the repository:
### Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

### Clone on your local machine

```bash
git clone https://github.com/your-username/ui.git
```
git clone [email protected]:shadcn-ui/ui.git

### Navigate to project directory

```bash
cd ui
```

### Install dependencies
### Create a new Branch

```bash
git checkout -b my-new-branch
```

### Install dependencies

```bash
pnpm install
```

Expand All @@ -65,13 +81,13 @@ You can use the `pnpm --filter=[WORKSPACE]` command to start the development pro

1. To run the `ui.shadcn.com` website:

```
```bash
pnpm --filter=www dev
```

2. To run the `shadcn-ui` package:

```
```bash
pnpm --filter=shadcn-ui dev
```

Expand Down Expand Up @@ -134,13 +150,10 @@ the following categories:

e.g. `feat(components): add new prop to the avatar component`


If you are interested in the detailed specification you can visit
https://www.conventionalcommits.org/ or check out the
[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).



## Requests for new components

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.
Expand Down

0 comments on commit 53f211b

Please sign in to comment.