Skip to content

Commit a215511

Browse files
authored
chore: add issue template (#175)
1 parent a9c9e81 commit a215511

File tree

4 files changed

+49
-1
lines changed

4 files changed

+49
-1
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Help us improve the generated API clients.
4+
---
5+
6+
## Description
7+
8+
<!-- A clear and concise description of what the bug is. -->
9+
10+
## Steps to reproduce
11+
12+
1. Use method `...`
13+
2. With parameters `...`
14+
3. See error
15+
16+
## Expected behavior
17+
18+
<!-- A clear and concise description of what you expected to happen. -->
19+
20+
## Environment
21+
22+
- OS: [e.g. Windows / Linux / macOS / iOS / Android]
23+
- Environment: [e.g. Browser / Node]
24+
- Client: [e.g. All / Recommend / Search / Insights]
25+
- Language: [e.g. JavaScript / PHP / Java]
26+
- Client version: [e.g. 5.0.0]
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for the generated API clients.
4+
---
5+
6+
## Describe the problem
7+
8+
<!-- Explain why a new feature is required. -->
9+
10+
## Describe the solution
11+
12+
<!-- Explain what your solution would look like. -->
13+
14+
## Alternatives you've considered
15+
16+
<!-- Is the proposed solution not the only one you've thought about? Please tell us more! -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: API client beta tester
5+
url: https://algolia.slack.com/archives/C0341QDM3EG
6+
about: Share with us issues about the generated clients.

.github/workflows/pr-title.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
- name: Pull Request title rules
1717
uses: deepakputhraya/[email protected]
1818
with:
19-
regex: '^(docs)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:javascript|php|java|cts|spec|script|ci)\)): .+'
19+
regex: '^(docs|chore)|((?:feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)\((?:javascript|php|java|cts|spec|script|ci)\)): .+'

0 commit comments

Comments
 (0)