From 86cb5d15708fc8c684ed5d912c0f6e27de2dbed2 Mon Sep 17 00:00:00 2001 From: DavdGao <102287034+DavdGao@users.noreply.github.com> Date: Fri, 12 Jan 2024 16:07:34 +0800 Subject: [PATCH] Add templates for issues and pull requests (#1) Add issue and pr templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 18 +++++++++++++ 3 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..c4e22c0a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..215ab80f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..b7103f366 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 \ No newline at end of file