archive-gh-me/tailwindcss
1
0
Fork 0
mirror of https://github.com/tailwindlabs/tailwindcss.git synced 2025-12-08 21:36:08 +00:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Adam Wathan 2022-02-25 14:14:20 -05:00 committed by GitHub
parent bbf3a37810
commit cd8f109981
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
.github/CONTRIBUTING.md vendored
View File

@ -6,7 +6,7 @@ Thanks for your interest in contributing to Tailwind CSS! Please take a moment t
**Please ask first before starting work on any significant new features.**
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](https://github.com/tailwindcss/tailwindcss/issues) to first discuss any significant new features. This includes things like adding new utilities, creating new at-rules, etc.
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 a feature request](https://github.com/tailwindlabs/tailwindcss/discussions/new?category=ideas) to first discuss any significant new ideas. This includes things like adding new utilities, creating new at-rules, etc.
## Coding standards
@ -32,33 +32,3 @@ npm run swcify && npm test
Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Tailwind, please include tests.
## Building the CSS and trying your changes manually
In addition to the automated tests, if you'd like to test the generated CSS manually with your own test HTML file, you can generate the default build by running:
```sh
npm run prepublishOnly
```
This will create new CSS files in the `/dist` folder which you can reference in your own test HTML file. We often test our own changes by creating an `index.html` file in the root of the Tailwind project itself that pulls in the `/dist/tailwind.css` stylesheet:
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<link rel="stylesheet" href="/dist/tailwind.css" />
<title>Hello, world!</title>
</head>
<body>
<h1 class="text-2xl font-bold text-center">Hello world!</h1>
</body>
</html>
```
You can then use a tool like [live-server](https://www.npmjs.com/package/live-server) to preview it in the browser:
```sh
live-server .
```