You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+70-4Lines changed: 70 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,48 @@
1
1
# Contributing
2
2
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
+
3
39
## Bug fixes
4
40
5
41
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.
6
42
7
43
## New features
8
44
9
-
If there's a new feature you'd like to see added to Tailwind, [share your idea with us](https://github.com/tailwindlabs/tailwindcss/discussions/new?category=ideas) in our discussion forum to get it on our radar as something to consider for a future release.
45
+
If there's a new feature you'd like to see added to Tailwind, [share your idea with us](https://github.com/tailwindlabs/tailwindcss/discussions/new?category=ideas) in our discussion forum to get it on our radar as something to consider for a future release before starting work on it.
10
46
11
47
**Please note that we don't often accept pull requests for new features.** Adding a new feature to Tailwind requires us to think through the entire problem ourselves to make sure we agree with the proposed API, which means the feature needs to be high on our own priority list for us to be able to give it the attention it needs.
12
48
@@ -28,10 +64,40 @@ pnpm run format
28
64
29
65
## Running tests
30
66
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:
32
80
33
81
```sh
34
-
pnpm build && pnpm test
82
+
pnpm build && pnpm test:ui
35
83
```
36
84
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
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+20-2Lines changed: 20 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,26 @@
4
4
5
5
**Please ask first before starting work on any significant new features.**
6
6
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 a discussion to first discuss any significant new features.
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.
0 commit comments