From a215511b8a023897fb77ee3d5f78702fbe566951 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Vannicatte?= <20689156+shortcuts@users.noreply.github.com> Date: Thu, 24 Feb 2022 18:15:37 +0100 Subject: [PATCH] chore: add issue template (#175) --- .github/ISSUE_TEMPLATE/Bug_report.md | 26 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 16 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ .github/workflows/pr-title.yml | 2 +- 4 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 0000000000..8fa650fd4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Help us improve the generated API clients. +--- + +## Description + + + +## Steps to reproduce + +1. Use method `...` +2. With parameters `...` +3. See error + +## Expected behavior + + + +## Environment + +- OS: [e.g. Windows / Linux / macOS / iOS / Android] +- Environment: [e.g. Browser / Node] +- Client: [e.g. All / Recommend / Search / Insights] +- Language: [e.g. JavaScript / PHP / Java] +- Client version: [e.g. 5.0.0] diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 0000000000..ea2cf4b577 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for the generated API clients. +--- + +## Describe the problem + + + +## Describe the solution + + + +## Alternatives you've considered + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..d56ccf1a9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false + +contact_links: + - name: API client beta tester + url: https://algolia.slack.com/archives/C0341QDM3EG + about: Share with us issues about the generated clients. diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml index 3e512357ef..cb848dc79a 100644 --- a/.github/workflows/pr-title.yml +++ b/.github/workflows/pr-title.yml @@ -16,4 +16,4 @@ jobs: - name: Pull Request title rules uses: deepakputhraya/action-pr-title@v1.0.2 with: - regex: '^(docs)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:javascript|php|java|cts|spec|script|ci)\)): .+' + regex: '^(docs|chore)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:javascript|php|java|cts|spec|script|ci)\)): .+'