From 34672513b85ec9242049e474a010d110750f0293 Mon Sep 17 00:00:00 2001 From: Aileen Villanueva Date: Mon, 9 Dec 2024 09:48:32 -0600 Subject: [PATCH 1/2] feat: add pull request and issues github template --- .github/ISSUE_TEMPLATE/bug_report.yml | 75 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++ .../pull_request_template.md | 40 ++++++++++ 4 files changed, 142 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..4f379f8a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,75 @@ +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: input + id: version + attributes: + label: Version + description: What version of our software are you running? + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d7c8e67a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..5ad2f153 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. + + +## Describe the solution you'd like + + +## Describe alternatives you've considered + + +## Additional context + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..25ad18a3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,40 @@ +## Description + + +## Type of Change + +- [ ]�� Breaking Change +- [ ] ✨ New Feature +- [ ] 🐛 Bug Fix +- [ ] 📝 Documentation Update +- [ ] 🎨 Style +- [ ] 🧑‍💻 Code Refactor +- [ ] 🔥 Performance Improvements +- [ ] ✅ Test +- [ ] 🤖 Build +- [ ] 🔁 CI +- [ ] 📦 Chore (Release) +- [ ] ⏩ Revert + +## Documentation + +- [ ] Documentation update required in orama-docs +- [ ] No documentation update needed + +## Breaking Changes + +N/A + +## Testing + +- [ ] Added/Updated Unit Tests +- [ ] Added/Updated Integration Tests +- [ ] Added/Updated E2E Tests +- [ ] Manual Testing + +## Screenshots/Videos + +N/A + +## Additional Notes + From 3b674b9c8ae01649c8bf22693c074ae74a0d30c2 Mon Sep 17 00:00:00 2001 From: Aileen Villanueva Date: Tue, 10 Dec 2024 12:34:34 -0600 Subject: [PATCH 2/2] add specification of Frontend framework and package --- .github/ISSUE_TEMPLATE/bug_report.yml | 41 +++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4f379f8a..350193c4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,11 +8,46 @@ body: 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: version + id: package-version attributes: - label: Version - description: What version of our software are you running? + label: Package Version + description: What version of the Orama package are you using? placeholder: "e.g., 1.0.0" validations: required: true