Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add issue template #175

Merged
merged 2 commits into from
Feb 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Help us improve the generated API clients.
---

## Description

<!-- A clear and concise description of what the bug is. -->

## Steps to reproduce

1. Use method `...`
2. With parameters `...`
3. See error

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## 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]
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an idea for the generated API clients.
---

## Describe the problem

<!-- Explain why a new feature is required. -->

## Describe the solution

<!-- Explain what your solution would look like. -->

## Alternatives you've considered

<!-- Is the proposed solution not the only one you've thought about? Please tell us more! -->
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion .github/workflows/pr-title.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)\)): .+'