Skip to content

Commit a0d84f6

Browse files
codecalmcodecalm
authored
Improve README and community health files (#2808)
1 parent b38cd32 commit a0d84f6

16 files changed

Lines changed: 432 additions & 229 deletions

‎.changeset/core-readme-refresh.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@tabler/core": patch
3+
---
4+
5+
Updated the npm package README with badges, quick links, CDN usage, documentation and changelog links.

‎.changeset/docs-how-to-contribute-sync.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@tabler/docs": patch
3+
---
4+
5+
Updated the How to Contribute guide with starter issues, GitHub Codespaces setup, a table of useful commands and pull request conventions.

‎.devcontainer/devcontainer.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "Tabler",
3+
"image": "mcr.microsoft.com/devcontainers/javascript-node:24",
4+
"postCreateCommand": "corepack enable && pnpm install",
5+
"forwardPorts": [3000, 3010],
6+
"portsAttributes": {
7+
"3000": {
8+
"label": "Preview website"
9+
},
10+
"3010": {
11+
"label": "Documentation website"
12+
}
13+
},
14+
"customizations": {
15+
"vscode": {
16+
"extensions": [
17+
"astro-build.astro-vscode",
18+
"esbenp.prettier-vscode",
19+
"stylelint.vscode-stylelint"
20+
]
21+
}
22+
}
23+
}

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Default owners for everything in the repo, unless a later match takes precedence.
2+
# They will be requested for review when someone opens a pull request.
3+
* @codecalm

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 72 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -3,70 +3,75 @@ description: Create a report to help us improve
33
title: "[BUG] "
44
labels: ["bug"]
55
body:
6-
- type: markdown
7-
attributes:
8-
value: "## Thank you for making a bug report!"
9-
- type: markdown
10-
attributes:
11-
value: |
12-
Thanks for taking the time to fill out this bug! It's really important to fill this form out completely as
13-
not filling it out will make the bug reports hard to replicate.
14-
- type: input
15-
id: browser
16-
attributes:
17-
label: Browser
18-
description: "What browser and version did this bug occur on?"
19-
placeholder: "e.g. Chrome ver.22, Safari ver.10"
20-
validations:
21-
required: true
22-
- type: input
23-
id: os
24-
attributes:
25-
label: OS
26-
description: "What is the operating system of your device?"
27-
placeholder: "e.g. Windows 10, iOS 14, Ubuntu 23.04"
28-
validations:
29-
required: true
30-
- type: input
31-
id: screen_size
32-
attributes:
33-
label: Screen size
34-
description: "What is the screen size of your device?"
35-
placeholder: "e.g. 800x600, 1920x1080"
36-
validations:
37-
required: true
38-
- type: textarea
39-
id: description
40-
attributes:
41-
label: Describe the bug
42-
description: "A clear and concise description of what the bug is."
43-
validations:
44-
required: true
45-
- type: textarea
46-
id: reproduce
47-
attributes:
48-
label: How to reproduce
49-
description: "How do you trigger this bug? Please walk us through it step by step."
50-
value: |
51-
1. Go to '...'
52-
2. Click on '...'
53-
3. Scroll down to '...'
54-
4. See error
55-
...
56-
validations:
57-
required: true
58-
- type: textarea
59-
id: screenshots
60-
attributes:
61-
label: Screenshots
62-
description: "If applicable, add screenshots here to help explain this problem. This helps us understand whats happening better."
63-
validations:
64-
required: false
65-
- type: input
66-
id: jsfiddle
67-
attributes:
68-
label: JSFiddle
69-
description: "Please add a jsFiddle replicating the bug. Without the jsFiddle most bug reports cannot be solved and will be closed."
70-
validations:
71-
required: false
72-
---
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Thank you for making a bug report!
10+
Thanks for taking the time to fill out this bug report! Please fill this form out completely —
11+
incomplete reports are hard to replicate and may be closed.
12+
- type: input
13+
id: version
14+
attributes:
15+
label: Tabler version
16+
description: "Which version of Tabler are you using?"
17+
placeholder: "e.g. 1.4.0"
18+
validations:
19+
required: true
20+
- type: input
21+
id: browser
22+
attributes:
23+
label: Browser
24+
description: "What browser and version did this bug occur on?"
25+
placeholder: "e.g. Chrome ver.22, Safari ver.10"
26+
validations:
27+
required: true
28+
- type: input
29+
id: os
30+
attributes:
31+
label: OS
32+
description: "What is the operating system of your device?"
33+
placeholder: "e.g. Windows 10, iOS 14, Ubuntu 23.04"
34+
validations:
35+
required: true
36+
- type: input
37+
id: screen_size
38+
attributes:
39+
label: Screen size
40+
description: "What is the screen size of your device?"
41+
placeholder: "e.g. 800x600, 1920x1080"
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: description
46+
attributes:
47+
label: Describe the bug
48+
description: "A clear and concise description of what the bug is."
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: reproduce
53+
attributes:
54+
label: How to reproduce
55+
description: "How do you trigger this bug? Please walk us through it step by step."
56+
value: |
57+
1. Go to '...'
58+
2. Click on '...'
59+
3. Scroll down to '...'
60+
4. See error
61+
...
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: screenshots
66+
attributes:
67+
label: Screenshots
68+
description: "If applicable, add screenshots here to help explain this problem. This helps us understand what's happening better."
69+
validations:
70+
required: false
71+
- type: input
72+
id: live_example
73+
attributes:
74+
label: Live example
75+
description: "Please add a link to a live example replicating the bug (for example a JSFiddle or CodeSandbox — you can start from our [starter template](https://stackblitz.com/github/tabler/tabler-starter)). Without it, most bug reports cannot be solved and will be closed."
76+
validations:
77+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://docs.tabler.io
5+
about: Guides for installing, using and customizing Tabler.
6+
- name: 💬 Questions and ideas
7+
url: https://github.com/tabler/tabler/discussions
8+
about: Ask questions, share ideas and discuss with the community.
9+
- name: 🛡️ Security issue
10+
url: https://github.com/tabler/tabler/blob/dev/SECURITY.md
11+
about: Please report security vulnerabilities privately — never in a public issue.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature request
2+
description: Suggest an idea for Tabler
3+
title: "[FEATURE] "
4+
labels: ["feature request"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest an improvement! If you are not sure about your idea yet,
10+
consider starting a [discussion](https://github.com/tabler/tabler/discussions) first.
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Is your feature request related to a problem?
15+
description: "A clear and concise description of what the problem is."
16+
placeholder: "Example: I'm always frustrated when..."
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: solution
21+
attributes:
22+
label: Describe the solution you'd like
23+
description: "A clear and concise description of what you want to happen."
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: "A clear and concise description of any alternative solutions or features you've considered."
31+
validations:
32+
required: false
33+
- type: textarea
34+
id: context
35+
attributes:
36+
label: Additional context
37+
description: "Add any other context, links or screenshots about the feature request here."
38+
validations:
39+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Thank you for contributing to Tabler! Please read CONTRIBUTING.md before opening a pull request. -->
2+
3+
## What does this PR do?
4+
5+
<!-- A short description of the change and why it is needed. Link related issues with "Fixes #123" or "Closes #123". -->
6+
7+
## Screenshots
8+
9+
<!-- For visual changes, add before/after screenshots. Remove this section if not applicable. -->
10+
11+
## Checklist
12+
13+
- [ ] The branch is based on `dev` and named `<type>/<short-description>` (for example `fix/markdown-table-overflow`)
14+
- [ ] `pnpm run build` passes locally
15+
- [ ] A changeset is included if the change affects any package (`pnpm exec changeset`)
16+
- [ ] Documentation is updated if needed (`docs/pages/**`)

‎.github/SUPPORT.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Getting support
2+
3+
Thanks for using Tabler! Here is where to go depending on what you need:
4+
5+
- **Documentation** — guides for installing, using and customizing Tabler: [docs.tabler.io](https://docs.tabler.io)
6+
- **Questions and ideas** — ask the community in [GitHub Discussions](https://github.com/tabler/tabler/discussions)
7+
- **Bug reports** — open an issue using the [bug report template](https://github.com/tabler/tabler/issues/new?template=bug_report.yml)
8+
- **Feature requests** — open an issue using the [feature request template](https://github.com/tabler/tabler/issues/new?template=feature_request.yml)
9+
- **Security issues** — please report privately, following our [security policy](../SECURITY.md)
10+
11+
Please keep the issue tracker for bugs and feature requests — usage questions get better answers in Discussions.

0 commit comments

Comments
 (0)