Skip to content

Commit 2bb4b4f

Browse files
authored
chore: clean up (#598)
* chore: clean up * chore: reorder plugin category
1 parent 2e9401a commit 2bb4b4f

File tree

3 files changed

+68
-300
lines changed

3 files changed

+68
-300
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- Please fill the table and check the cases below. If this template is not filled properly, your pull request might be rejected. -->
2+
13
| Name | Link |
24
| -------------------- | -------------------- |
35
| _Resource name here_ | _Resource link here_ |
@@ -6,9 +8,9 @@ _Resource description here_
68

79
---
810

11+
- [ ] I have read and followed the [contribution guidelines](https://github.com/aniftyco/awesome-tailwindcss/blob/master/CONTRIBUTING.md)
912
- [ ] My item is in the right category
1013
- [ ] My item is logically grouped below similar items
1114
- [ ] My item's name and description respects the conventions of the list
12-
- [ ] My item is awesome
15+
- [ ] My item is awesome, and I really mean it
1316
- [ ] My item is in line with the [Tailwind brand usage guidelines](https://tailwindcss.com/brand#usage)
14-
- [ ] I have read and followed the [contribution guidelines](https://github.com/aniftyco/awesome-tailwindcss/blob/master/CONTRIBUTING.md)

CONTRIBUTING.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
# Contributing Guide
1+
# Contributing guide
22

3-
Please be sure to follow the [Tailwind CSS Community Guidelines](https://github.com/tailwindcss/tailwindcss/blob/master/.github/CODE_OF_CONDUCT.md). After your pull request, this list must still be [Awesome](https://github.com/sindresorhus/awesome)-elligible.
3+
After your pull request, this list must still be [Awesome](https://github.com/sindresorhus/awesome)-elligible.
44

5-
## General Guidelines
5+
## General guidelines
66

77
1. The formats and categories described below must be respected.
8-
2. The added item must be **awesome**. If you have doubts about its awesomess, it probably isn't... sorry.
8+
2. The added item must be **awesome**. It means, really good and useful. If you have doubts about its awesomess, it probably isn't... sorry.
99
- > Only has awesome items. Awesome lists are curations of the best, not everything. _[Awesome Guidelines](https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md#requirements-for-your-awesome-list)_
1010
3. Unless specified otherwise below, an item must be added to the bottom of its emoji group.
11-
4. [`awesome-lint`](https://github.com/sindresorhus/awesome-lint) must be used before creating a pull request.
12-
5. Your project must not violate the [Tailwind brand usage guidelines](https://tailwindcss.com/brand#usage).
11+
4. Your project must not violate the [Tailwind brand usage guidelines](https://tailwindcss.com/brand#usage).
1312

14-
## Formats, Naming Conventions and Descriptions
13+
## Formats, naming conventions and descriptions
1514

16-
- Every item must have the following format: `[Item Name](link) - Description.`.
15+
- Every item must have the following format: `[Item name](link) - Description.`.
1716
- If a category has an emoji that applies to a new item, it must be used.
1817
- Every name and description must be in English.
1918
- Every mention to Tailwind CSS must use the exact name `Tailwind CSS`, except for plugin/library/product names.
@@ -35,45 +34,32 @@ Please be sure to follow the [Tailwind CSS Community Guidelines](https://github.
3534
- ✔ Extends `object-position` utilities.
3635
- ✖ A plugin that adds variants for dark mode.
3736
- ✖ Additional variants for touch based media queries.
38-
- Descriptions must describe the resource, not be a slogan. This rule applies to every resource sub-category except [Demos, Samples & Tutorials](README.md/#demos-samples--tutorials).
37+
- Descriptions must describe the resource, not be a slogan.
3938
- ✔ Visual Studio Code IntelliSense extension for Tailwind CSS.
4039
- ✔ React UI library using Tailwind CSS.
4140
- ✖ Brings Tailwind CSS into React.
42-
- [Learning](README.md/#learning) resources' descriptions must be a short but explicit description of the content. It _should_ start with a verb or by "How to" when applicable.
43-
- ✔ Rebuilding Acquia’s hosting dashboard with Vue.js and Tailwind CSS.
44-
- ✖ Acquia’s hosting dashboard rebuilt with Vue.js and Tailwind CSS.
45-
- ✔ How to setup Tailwind CSS in Phoenix 1.4.
46-
- ✖ Setting up Tailwind CSS in Phoenix 1.4
4741

4842
# Categories
4943

50-
## Useful Links
44+
## Useful links
5145

5246
This category contains resources that are official _or_ widely known and used in the Tailwind CSS community. If you find something that we forgot to add here, or if you built something a while ago that has become quite popular in the community, feel free to add it. Otherwise, it most likely belongs in the other categories.
5347

54-
## IDE Extensions
48+
## IDE extensions
5549

5650
If you made an extension that makes the usage of Tailwind CSS easier, make sure it is properly distributable before adding it to the list. Please use the format `[<extension type/functionality> for <IDE name>](link) - <Extension functionality> for <Full IDE name>` when applicable.
5751

5852
## Plugins
5953

60-
This category must only contain Tailwind CSS plugins that use the [official plugin architecture](https://tailwindcss.com/docs/plugins/) to extend the framework. New plugins must be added to the bottom of the corresponding category, represented by emojis.
54+
This category must only contain Tailwind CSS plugins that use the [official plugin architecture](https://tailwindcss.com/docs/adding-custom-styles) to extend the framework. New plugins must be added to the bottom of the corresponding category, represented by emojis.
6155

6256
## Tools
6357

6458
Tools can be anything that help with setting up or working with Tailwind CSS, or stuff that extend other services to bring Tailwind CSS in them.
6559

66-
## UI Libraries, Components & Templates
60+
## UI libraries, components & templates
6761

68-
This category must contain UI libraries made for Tailwind CSS, as well as standalone components that are optimized for distribution. Non-tool-agnostic templates should be added to the **Starters & Themes** category.
69-
70-
## Starters & Themes
71-
72-
This category contains boilerplates projects, starters projects and tools made for using Tailwind CSS as well as tool themes made for Tailwind CSS.
73-
74-
## Learning
75-
76-
Anything that is a material that can be used to better understand Tailwind CSS can be added here. Awesome blog posts, code samples, tutorials on any platform are welcome.
62+
This category must contain UI libraries made for Tailwind CSS, standalone components that are optimized for distribution, and full, standalone templates.
7763

7864
# Pull request and commits
7965

0 commit comments

Comments
 (0)