From 4074d93d26b697c0524d987f4e119982162b14fe Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Thu, 2 Nov 2023 10:11:12 +0100 Subject: [PATCH] Add GH templates and codeowner (#57) --- .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/bug_report.yml | 41 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 23 ++++++++++++ .github/ISSUE_TEMPLATE/maintainer-blank.yml | 10 +++++ .github/dependabot.yml | 6 +++ .github/pull_request_template.md | 15 ++++++++ 7 files changed, 101 insertions(+) create mode 100644 .github/CODEOWNERS 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.yml create mode 100644 .github/ISSUE_TEMPLATE/maintainer-blank.yml create mode 100644 .github/dependabot.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..fd89ad1 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @marandaneto diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..95199c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,41 @@ +name: 🐞 Bug Report +description: Tell us about something that's not working the way we (probably) intend. +labels: ["bug"] +body: + + + - type: input + id: version + attributes: + label: Version + description: SDK Version + placeholder: 3.0.0 ← should look like this + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: How can we see what you're seeing? Specific is terrific. + placeholder: |- + 1. foo + 2. bar + 3. baz + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Result + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Result + description: Logs? Screenshots? Yes, please. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..64d359b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask in the forums + url: https://posthog.com/questions + about: A place to ask questions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..3ae03e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,23 @@ +name: 💡 Feature Request +description: Tell us about a problem our SDK could solve but doesn't. +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem could we solve that it doesn't? + placeholder: |- + I want to make whirled peas, but it doesn't blend. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Solution Brainstorm + description: We know you have bright ideas to share ... share away, friend. + placeholder: |- + Add a blender to it. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/maintainer-blank.yml b/.github/ISSUE_TEMPLATE/maintainer-blank.yml new file mode 100644 index 0000000..e120920 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintainer-blank.yml @@ -0,0 +1,10 @@ +name: Blank Issue +description: Blank Issue. Reserved for maintainers. +body: + - type: textarea + id: description + attributes: + label: Description + description: Please describe the issue. + validations: + required: true diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b88a67a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: weekly diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0425157 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## :bulb: Motivation and Context + + + + +## :green_heart: How did you test it? + + +## :pencil: Checklist + + +- [ ] I reviewed the submitted code. +- [ ] I added tests to verify the changes. +- [ ] I updated the docs if needed. +- [ ] No breaking change or entry added to the changelog.