Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: enhance documentation and guidelines #41

Merged
merged 3 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: 🐛 Bug Report
description: Found a bug? Let us help you fix it!
title: 'bug: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Let's fix it together.

- type: dropdown
id: component
attributes:
label: Component Category
description: Which component type has the issue?
options:
- Inputs
- Buttons
- Accordions
- Alerts
- Avatars
- Badges
- Banners
- Checkboxes
- Dialogs
- Dropdowns
- 'Hover Cards'
- Notifications
- Popovers
- Radios
- Sliders
- Switches
- Textareas
- Tooltips
- Base UI Components
- Other
validations:
required: true

- type: input
id: component-id
attributes:
label: Component ID
description: Which specific component? (e.g., input-01, button-02)
placeholder: 'input-01'

- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: What's happening that shouldn't be?
placeholder: 'When I click the button...'
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What should happen instead?
placeholder: 'The button should...'
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Help us find the bug
value: |
1. Go to '...'
2. Click on '...'
3. See error
validations:
required: true

- type: dropdown
id: browsers
attributes:
label: Affected Browsers
multiple: true
options:
- Firefox
- Chrome
- Safari
- Edge
- Other

- type: textarea
id: logs
attributes:
label: Error Logs
description: Any error messages in the console?
render: shell

- type: markdown
attributes:
value: |
> [!TIP]
> Include screenshots or screen recordings if possible - they're super helpful!
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/component_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: 🧩 Component Request
description: Have an idea for a new component? Let's build it!
title: 'component: '
labels: ['component']
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new component! Let's make something awesome together.

> [!NOTE]
> This project is a copy of the original Origin UI, reimplemented in Svelte. New components should aim to match the original Origin UI's design and functionality.

- type: dropdown
id: component-type
attributes:
label: Request Type
description: What kind of component are you looking for?
options:
- New Component Category
- New Component in Existing Category
- Variation of Existing Component
validations:
required: true

- type: dropdown
id: category
attributes:
label: Component Category
description: Where should this component live?
options:
- Inputs
- Buttons
- Accordions
- Alerts
- Avatars
- Badges
- Banners
- Checkboxes
- Dialogs
- Dropdowns
- 'Hover Cards'
- Notifications
- Popovers
- Radios
- Sliders
- Switches
- Textareas
- Tooltips
- New Category (describe below)
validations:
required: true

- type: input
id: new-category
attributes:
label: New Category Name
description: If you selected "New Category", what should we call it?
placeholder: 'Date Pickers'

- type: textarea
id: description
attributes:
label: Component Description
description: What should this component do?
placeholder: 'A component that...'
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: Use Cases
description: When would someone use this component?
value: |
1. When users need to...
2. In situations where...
validations:
required: true

- type: textarea
id: features
attributes:
label: Key Features
description: What features should it have?
value: |
- [ ] Feature 1
- [ ] Feature 2
validations:
required: true

- type: textarea
id: examples
attributes:
label: Examples & Inspiration
description: Share links to similar components
placeholder: |
- Design inspiration: ...
- Similar component: ...

- type: markdown
attributes:
value: |
> [!TIP]
> Add mockups or sketches if you have them - they help us understand your vision!
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://originui-svelte.pages.dev/
about: Check our documentation for guides and examples
- name: 💬 Discussions
url: https://github.com/max-got/originui-svelte/discussions
about: Ask questions and share ideas
- name: 🎨 Original Origin UI
url: https://originui.com/
about: View the original components we're recreating
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: 💡 Feature Request
description: Got an idea to make Origin UI - Svelte better? Share it here!
title: 'feat: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for helping make Origin UI - Svelte better! Let's hear your idea.

> [!NOTE]
> This project is a copy of the original Origin UI, reimplemented in Svelte. New features should align with and complement the original Origin UI's functionality.

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What area would this improve?
options:
- Developer Experience
- Component Enhancement
- Documentation
- Performance
- Accessibility
- Other
validations:
required: true

- type: dropdown
id: component
attributes:
label: Related Component
description: Does this affect a specific component type?
options:
- Not Component Specific
- Inputs
- Buttons
- Accordions
- Alerts
- Avatars
- Badges
- Banners
- Checkboxes
- Dialogs
- Dropdowns
- 'Hover Cards'
- Notifications
- Popovers
- Radios
- Sliders
- Switches
- Textareas
- Tooltips
- Base UI Components
validations:
required: true

- type: textarea
id: problem
attributes:
label: Current Limitation
description: What's missing or could be better?
placeholder: 'It would be great if...'
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How could we solve this?
placeholder: 'We could...'
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Approaches
description: Are there other ways to solve this?
placeholder: 'Another way could be...'

- type: textarea
id: examples
attributes:
label: Examples & References
description: Share any examples or references
placeholder: |
- Similar feature in other libraries: ...
- Reference implementation: ...

- type: markdown
attributes:
value: |
> [!TIP]
> Not sure if this is the right approach? Open a discussion first - we're happy to brainstorm together!
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Description

<!-- Provide a clear and concise description of your changes -->

## Type of Change

<!-- Put an `x` in the boxes that apply -->

- [ ] New component(s)
- [ ] Enhancement to existing component
- [ ] Bug fix
- [ ] Documentation
- [ ] Other:

## Component Details

<!-- Only fill this section if you're adding/modifying components -->

**Category:** <!-- e.g., inputs, buttons -->
**Component Name(s):** <!-- e.g., input-58.svelte -->

## Checklist

<!-- Put an `x` in the boxes that apply -->

- [ ] Matches original design (or improves it)
- [ ] Uses Svelte 5 runes
- [ ] Follows project structure
- [ ] Ran `pnpm generate:registry`
- [ ] Added route config (if new category)
- [ ] Added dependencies to `constants.ts` (if needed)
- [ ] Added placeholder content (if .todo/.soon)
- [ ] Tested in light/dark mode
- [ ] Checked accessibility

## Screenshots

<!-- Add before/after screenshots if applicable -->

## Related Issues

<!-- Link related issues using #issue-number -->

---

> [!TIP]
> Need help? Check our [Contributing Guide](../README.md#contributing) or open a Draft PR for early feedback!
Loading
Loading