Skip to content

Commit

Permalink
Add templates for issues and pull requests (#1)
Browse files Browse the repository at this point in the history
Add issue and pr templates
  • Loading branch information
DavdGao authored Jan 12, 2024
1 parent 1589a45 commit 86cb5d1
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[Bug]:'
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. You code
2. How to execute
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Error messages**
Detailed error messages.

**Environment (please complete the following information):**
- AgentScope Version: [e.g. 0.0.1 via `print(agentscope.__version__)`]
- Python Version: [e.g. 3.9]
- OS: [e.g. macos, windows]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[Feature]: '
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Pull Request
about: Create a pull request
---
## Description

[Please describe the background, purpose, changes made, and how to test this PR]



## Checklist

Please check the following items before code is ready to be reviewed.

- [ ] Code has passed all tests
- [ ] Docstrings have been added/updated in Google Style
- [ ] Documentation has been updated
- [ ] Code is ready for review

0 comments on commit 86cb5d1

Please sign in to comment.