Skip to content

Commit 4130ba1

Browse files
Update contribution docs
1 parent 4f8539c commit 4130ba1

File tree

2 files changed

+89
-5
lines changed

2 files changed

+89
-5
lines changed

.github/CONTRIBUTING.md

+69-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
# Contributing
22

3+
## Requirements
4+
5+
Before getting started, ensure your system has access to the following tools:
6+
7+
- [Node.js](https://nodejs.org/)
8+
- [Rustup](https://rustup.rs/)
9+
- [pnpm](https://pnpm.io/)
10+
11+
## Getting started
12+
13+
```sh
14+
# Install dependencies
15+
pnpm install
16+
17+
# Install Rust toolchain and WASM targets
18+
rustup default stable
19+
rustup target add wasm32-wasip1-threads
20+
21+
# Build the project
22+
pnpm build
23+
```
24+
25+
## Development workflow
26+
27+
During development, you can run tests in watch mode:
28+
29+
```sh
30+
pnpm tdd
31+
```
32+
33+
The `playgrounds` directory contains example projects you can use to test your changes. To start the Vite playground, use:
34+
35+
```sh
36+
pnpm build && pnpm vite
37+
```
38+
339
## Bug fixes
440

541
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.
@@ -28,10 +64,40 @@ pnpm run format
2864

2965
## Running tests
3066

31-
You can run the test suite using the following commands:
67+
You can run the TypeScript and Rust test suites using the following command:
68+
69+
```sh
70+
pnpm test
71+
```
72+
73+
To run the integration tests, use:
74+
75+
```sh
76+
pnpm build && pnpm test:integrations
77+
```
78+
79+
Additionally, some features require testing in browsers (i.e to ensure CSS variable resolution works as expected). These can be run via:
3280

3381
```sh
34-
pnpm build && pnpm test
82+
pnpm build && pnpm test:ui
3583
```
3684

37-
Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Tailwind, please include tests.
85+
Please ensure that all tests are passing when submitting a pull request. If you're adding new features to Tailwind CSS, always include tests.
86+
87+
After a successful build, you can also use the npm package tarballs created inside the `dist/` folder to install your build in other local projects.
88+
89+
## Pull request process
90+
91+
When submitting a pull request:
92+
93+
- Ensure the pull request title and description explain the changes you made and why you made them.
94+
- Include a test plan section that outlines how you tested your contributions. We do not accept contributions without tests.
95+
- Ensure all tests pass. You can add the tag `[ci-all]` in your pull request description to run the test suites across all platforms.
96+
97+
When a pull request is created, Tailwind CSS maintainers will be notified automatically.
98+
99+
## Communication
100+
101+
- **GitHub discussions**: For feature ideas and general questions
102+
- **GitHub issues**: For bug reports
103+
- **GitHub pull requests**: For code contributions

.github/PULL_REQUEST_TEMPLATE.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,26 @@
44
55
**Please ask first before starting work on any significant new features.**
66
7-
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create an issue to first discuss any significant new features. This includes things like adding new utilities, creating new at-rules, or adding new component examples to the documentation.
7+
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create an issue to first discuss any significant new features.
88
9-
https://github.com/tailwindcss/tailwindcss/blob/master/.github/CONTRIBUTING.md
9+
For more info, check out the contributing guide:
10+
11+
https://github.com/tailwindcss/tailwindcss/blob/main/.github/CONTRIBUTING.md
12+
13+
-->
14+
15+
## Summary
16+
17+
<!--
18+
19+
Provide a summary of the issue and the changes you're making. How does your change solve the problem?
20+
21+
-->
22+
23+
## Test plan
24+
25+
<!--
26+
27+
Explain how you tested your changes. Include the exact commands that you used to verify the change works and include screenshots/screen recordings of the update behavior in the browser if applicable.
1028
1129
-->

0 commit comments

Comments
 (0)