-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: adding docs to repo * chore: updated pr and issue templates * added designer collaboration documentation * added config yaml * moved issue templates
- Loading branch information
Showing
12 changed files
with
337 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Accessibility Issue | ||
|
||
## Summary | ||
|
||
What accessibility issue are you experiencing? | ||
|
||
- **What component or feature is affected?** | ||
- **How does this impact users with disabilities or assistive technologies?** | ||
|
||
--- | ||
|
||
## Steps to Reproduce | ||
|
||
Provide clear steps to replicate the issue: | ||
|
||
1. Go to... | ||
2. Click on... | ||
3. Observe the issue. | ||
|
||
--- | ||
|
||
## Expected Behavior | ||
|
||
What is the expected accessible behavior? | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Include details about your testing environment: | ||
|
||
- **Browser/Device:** | ||
- **Assistive Technology (if applicable):** | ||
- **WCAG Criteria Violated (if known):** | ||
|
||
--- | ||
|
||
Thank you for helping us make Murrieta more inclusive! 🌟 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Component Request | ||
|
||
## Summary | ||
|
||
What is the proposed component? | ||
|
||
- **What problem does it solve?** | ||
- **How does it align with the goals of Murrieta?** | ||
|
||
--- | ||
|
||
## Requirements | ||
|
||
Provide details about the component's functionality, appearance, and usage: | ||
|
||
- **Key Features:** | ||
- **States (e.g., hover, active):** | ||
- **Accessibility Considerations:** | ||
|
||
--- | ||
|
||
## Examples or References | ||
|
||
Are there examples or references for this component (e.g., existing design systems, mockups)? | ||
|
||
--- | ||
|
||
Thank you for suggesting a new component for Murrieta! 🎉 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Design Feedback | ||
|
||
## Component/Feature | ||
|
||
Which component or design feature are you providing feedback for? | ||
|
||
--- | ||
|
||
## Feedback | ||
|
||
What works well? | ||
What could be improved? | ||
|
||
--- | ||
|
||
## Suggestions | ||
|
||
Do you have specific suggestions for improvement? | ||
Include examples, references, or mockups if available. | ||
|
||
--- | ||
|
||
Thank you for sharing your insights to enhance our design system! 🎨 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Discussion Topic | ||
|
||
## Topic | ||
|
||
What is the topic or idea you’d like to discuss? | ||
|
||
--- | ||
|
||
## Goals | ||
|
||
What are the goals or desired outcomes of this discussion? | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Include any relevant details, references, or examples to support this topic. | ||
|
||
--- | ||
|
||
Let’s collaborate and brainstorm together! 💡 |
27 changes: 27 additions & 0 deletions
27
.github/.github/ISSUE_TEMPLATE/documentation_improvement.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Documentation Improvement | ||
|
||
## Summary | ||
|
||
What section of the documentation needs improvement? | ||
|
||
- **Is it unclear, missing, or incorrect?** | ||
- **What impact does this have on users or contributors?** | ||
|
||
--- | ||
|
||
## Suggested Changes | ||
|
||
Provide specific details on how to improve the documentation: | ||
|
||
- **What changes are required?** | ||
- **Are there examples or references that could be helpful?** | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Include any other context, screenshots, or files related to this issue. | ||
|
||
--- | ||
|
||
Thank you for improving the documentation! 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Feature Request Template | ||
|
||
## Summary | ||
|
||
Provide a clear and concise summary of the feature you are requesting. | ||
|
||
**What problem does this feature solve?** | ||
(Explain the challenge or need this feature would address.) | ||
|
||
**How does this align with the goals of the Murrieta Design System?** | ||
(Explain how this feature supports the design system’s principles or purpose.) | ||
|
||
--- | ||
|
||
## Proposed Solution | ||
|
||
Describe your proposed solution in detail: | ||
|
||
- **Feature Overview**: What would the feature do? | ||
- **User Stories**: (Optional) Include specific user stories or use cases. | ||
- **Visuals**: (Optional) Attach wireframes, mockups, or diagrams to illustrate the feature. | ||
|
||
--- | ||
|
||
## Alternatives Considered | ||
|
||
List any alternative solutions or approaches you’ve thought of and why you believe your proposal is the best option. | ||
|
||
--- | ||
|
||
## Additional Information | ||
|
||
Add any other context, links, or resources that might help in evaluating your feature request. | ||
|
||
--- | ||
|
||
Thank you for helping to make the Murrieta Design System better! 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Performance Issue | ||
|
||
## Summary | ||
|
||
What performance issue are you experiencing? | ||
|
||
- **Which component or feature is impacted?** | ||
- **How was this issue identified?** | ||
|
||
--- | ||
|
||
## Steps to Reproduce | ||
|
||
Provide steps to replicate the issue: | ||
|
||
1. Go to... | ||
2. Perform... | ||
3. Measure performance. | ||
|
||
--- | ||
|
||
## Environment | ||
|
||
Include details about your environment: | ||
|
||
- **Murrieta Version:** | ||
- **Browser/Device:** | ||
|
||
--- | ||
|
||
## Suggested Improvements | ||
|
||
Do you have ideas or recommendations for improving performance? | ||
|
||
--- | ||
|
||
Thank you for helping us optimize Murrieta! 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Bug Report Template | ||
|
||
## Summary | ||
|
||
Provide a clear and concise summary of the issue you are experiencing. | ||
|
||
**What is the bug?** | ||
(Describe the issue in a few sentences.) | ||
|
||
**What is the expected behavior?** | ||
(Explain what you expected to happen instead.) | ||
|
||
--- | ||
|
||
## Steps to Reproduce | ||
|
||
Provide the steps to reproduce the issue. Include screenshots or recordings if applicable. | ||
|
||
1. Go to... | ||
2. Click on... | ||
3. Scroll to... | ||
4. See the issue. | ||
|
||
--- | ||
|
||
## Environment | ||
|
||
Provide details about the environment where the issue occurs: | ||
|
||
- **Murrieta Design System Version**: | ||
- **Node/Bun Version**: | ||
- **Browser (if applicable)**: | ||
- **Operating System**: | ||
|
||
--- | ||
|
||
## Screenshots or Videos | ||
|
||
If applicable, add screenshots or videos to help illustrate the problem. | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Include any other context about the problem, such as logs, errors, or possible causes. | ||
|
||
--- | ||
|
||
Thank you for reporting this bug! We’ll review it and get back to you as soon as possible. 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Request for Examples | ||
|
||
## Summary | ||
|
||
What example are you requesting? | ||
|
||
- **Which component or feature?** | ||
- **What scenario or use case should it address?** | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Provide any details, references, or use cases that would help us create the example. | ||
|
||
--- | ||
|
||
Thank you for helping us make Murrieta easier to use! 🙌 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Security Issue | ||
|
||
## Summary | ||
|
||
What is the security concern? | ||
|
||
- **Which component or feature is affected?** | ||
- **What are the potential risks or impacts?** | ||
|
||
--- | ||
|
||
## Steps to Reproduce | ||
|
||
Provide steps to replicate the vulnerability (if possible): | ||
|
||
1. Go to... | ||
2. Perform... | ||
3. Observe the issue. | ||
|
||
--- | ||
|
||
## Recommended Fix | ||
|
||
Do you have suggestions for resolving the issue? | ||
|
||
--- | ||
|
||
## Responsible Disclosure | ||
|
||
If this issue involves sensitive information, please contact us directly at **[maintainer email]** instead of submitting it here. | ||
|
||
--- | ||
|
||
Thank you for helping to keep Murrieta secure! 🔒 |
24 changes: 24 additions & 0 deletions
24
.github/.github/ISSUE_TEMPLATE/theme_customization_consideration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Theme Customization Feedback | ||
|
||
## Summary | ||
|
||
What aspect of theme customization needs feedback or improvement? | ||
|
||
- **What issues or challenges are you experiencing?** | ||
- **What is working well?** | ||
|
||
--- | ||
|
||
## Suggested Improvements | ||
|
||
Do you have ideas or recommendations for improving theme customization? | ||
|
||
--- | ||
|
||
## Additional Context | ||
|
||
Include any relevant details, examples, or use cases. | ||
|
||
--- | ||
|
||
Thank you for sharing your feedback on themes! 🎨 |