Skip to content

docs: improve contributing commands and playground instructions #19705

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

Closed
pavan-sh wants to merge 1 commit into from
+18 −8
Closed

docs: improve contributing commands and playground instructions #19705

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,20 @@ During development, you can run tests in watch mode:
pnpm tdd
```

The `playgrounds` directory contains example projects you can use to test your changes. To start the Vite playground, use:
The `playgrounds` directory contains example projects you can use to test your changes.

- Start the Vite playground:

```sh
pnpm build && pnpm vite
```

- Start the Next.js playground:

```sh
pnpm build && pnpm nextjs
```

## Bug fixes

If you've found a bug in Tailwind that you'd like to fix, [submit a pull request](https://github.com/tailwindlabs/tailwindcss/pulls) with your changes. Include a helpful description of the problem and how your changes address it, and provide tests so we can verify the fix works as expected.
Expand All @@ -50,16 +58,18 @@ If you open a pull request for a new feature, we're likely to close it not becau

## Coding standards

Our code formatting rules are defined in the `"prettier"` section of [package.json](https://github.com/tailwindlabs/tailwindcss/blob/main/package.json). You can check your code against these standards by running:
Our code formatting rules are defined in the `"prettier"` section of [package.json](https://github.com/tailwindlabs/tailwindcss/blob/main/package.json).

- Check formatting + linting:

```sh
pnpm run lint
pnpm lint
```

To automatically fix any style violations in your code, you can run:
- Fix formatting:

```sh
pnpm run format
pnpm format
```

## Running tests
Expand Down Expand Up @@ -98,6 +108,6 @@ When a pull request is created, Tailwind CSS maintainers will be notified automa

## Communication

- **GitHub discussions**: For feature ideas and general questions
- **GitHub issues**: For bug reports
- **GitHub pull requests**: For code contributions
- **GitHub Discussions**: For feature ideas and general questions
- **GitHub Issues**: For bug reports
- **GitHub Pull Requests**: For code contributions