-
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.
Merge pull request #64 from oramasearch/feature/orm-1857
feat: add pull request and issues github template
- Loading branch information
Showing
4 changed files
with
177 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,110 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: ["bug", "triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: dropdown | ||
id: package | ||
attributes: | ||
label: Package | ||
description: Which Orama package are you using? | ||
options: | ||
- "@orama/wc-components (Web Components)" | ||
- "@orama/react-components" | ||
- "@orama/vue-components" | ||
- "@orama/angular-components" | ||
- Other/Not Sure | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: framework | ||
attributes: | ||
label: Framework | ||
description: Which framework are you using? | ||
options: | ||
- None (Vanilla JS/HTML) | ||
- React | ||
- Vue | ||
- Angular | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: framework-version | ||
attributes: | ||
label: Framework Version | ||
description: What version of the framework are you using? (if applicable) | ||
placeholder: "e.g., React 18.2.0" | ||
|
||
- type: input | ||
id: package-version | ||
attributes: | ||
label: Package Version | ||
description: What version of the Orama package are you using? | ||
placeholder: "e.g., 1.0.0" | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: Browser | ||
description: What browsers are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Chrome | ||
- Firefox | ||
- Safari | ||
- Microsoft Edge | ||
- Other | ||
|
||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: "A clear and concise description of what the bug is." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: Steps to reproduce | ||
description: How can we reproduce this issue? | ||
placeholder: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code. | ||
render: shell | ||
|
||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here (screenshots, videos, etc.) | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Orama Documentation | ||
url: https://docs.orama.com | ||
about: Check our documentation before creating an issue | ||
- name: Orama Community Support | ||
url: https://discord.gg/orama | ||
about: Please ask and answer questions here |
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,19 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '[Feature Request]' | ||
labels: 'enhancement' | ||
assignees: '' | ||
--- | ||
|
||
## Is your feature request related to a problem? Please describe. | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
## Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
## Describe alternatives you've considered | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
## Additional context | ||
<!-- Add any other context or screenshots about the feature request here. --> |
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,40 @@ | ||
## Description | ||
<!-- Provide a brief description of the changes in this PR --> | ||
|
||
## Type of Change | ||
<!-- Mark the relevant option(s) with 'x' --> | ||
- [ ]�� Breaking Change | ||
- [ ] ✨ New Feature | ||
- [ ] 🐛 Bug Fix | ||
- [ ] 📝 Documentation Update | ||
- [ ] 🎨 Style | ||
- [ ] 🧑💻 Code Refactor | ||
- [ ] 🔥 Performance Improvements | ||
- [ ] ✅ Test | ||
- [ ] 🤖 Build | ||
- [ ] 🔁 CI | ||
- [ ] 📦 Chore (Release) | ||
- [ ] ⏩ Revert | ||
|
||
## Documentation | ||
<!-- Mark the relevant option with 'x' --> | ||
- [ ] Documentation update required in orama-docs | ||
- [ ] No documentation update needed | ||
|
||
## Breaking Changes | ||
<!-- If there are breaking changes, list them here and explain why they're necessary --> | ||
N/A | ||
|
||
## Testing | ||
<!-- Describe the testing you've done --> | ||
- [ ] Added/Updated Unit Tests | ||
- [ ] Added/Updated Integration Tests | ||
- [ ] Added/Updated E2E Tests | ||
- [ ] Manual Testing | ||
|
||
## Screenshots/Videos | ||
<!-- If applicable, add screenshots or videos to help explain your changes --> | ||
N/A | ||
|
||
## Additional Notes | ||
<!-- Add any additional notes or context about the PR here --> |