Skip to content

Commit c5dfc36

Browse files
lightislostlightislost
committed
add issue template
1 parent f83c1c3 commit c5dfc36

File tree

5 files changed

+392
-0
lines changed

5 files changed

+392
-0
lines changed

‎.github/CONTRIBUTING.md

+190
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
2+
3+
Thank you for your interest in the Codefuse project. We warmly welcome any suggestions, opinions (including criticisms), comments, and contributions to the Codefuse project.
4+
5+
Your suggestions, opinions, and comments on Codefuse can be directly submitted through GitHub Issues.
6+
7+
There are many ways to participate in the Codefuse project and contribute to it: code implementation, test writing, process tool improvement, documentation enhancement, and more. We welcome any contributions and will add you to our list of contributors.
8+
9+
Furthermore, with enough contributions, you may have the opportunity to become a Committer for Codefuse.
10+
11+
For any questions, you can contact us for timely answers through various means including WeChat, Gitter (an instant messaging tool provided by GitHub), email, and more.
12+
13+
14+
## Getting Started
15+
If you are new to the Codefuse community, you can:
16+
- Follow the Codefuse GitHub repository.
17+
- Join related WeChat groups for Codefuse to ask questions at any time;
18+
19+
Through the above methods, you can stay up-to-date with the development dynamics of the Codefuse project and express your opinions on topics of interest.
20+
21+
22+
## Contributation Ways
23+
This contribution guide is not just about writing code. We value and appreciate help in all areas. Here are some ways you can contribute:
24+
- Documentation
25+
- Issues
26+
- Pull Requests (PR)
27+
28+
### Improve Documentation
29+
Documentation is the main way for you to understand Codefuse and is also where we need the most help!
30+
31+
By browsing the documentation, you can deepen your understanding of Codefuse and also help you grasp the features and technical details of Codefuse. If you find any issues with the documentation, please contact us in time;
32+
33+
If you are interested in improving the quality of the documentation, whether it is revising an address of a page, correcting a link, or writing a better introductory document, we are very welcoming!
34+
35+
Most of our documentation is written in markdown format. You can directly modify and submit documentation changes in the docs/ directory on GitHub. For submitting code changes, please refer to Pull Requests.
36+
37+
### If You Discover a Bug or Issue
38+
If you discover a bug or issue, you can directly submit a new Issue through GitHub Issues, and someone will handle it regularly. For more details, see Issue Template.[Issue Template](#issue-template)
39+
40+
You can also choose to read and analyze the code to fix it yourself (it is best to communicate with us before doing so, as someone might already be working on the same issue), and then submit a Pull Request.
41+
42+
### Modify Code and Submit a PR (Pull Request)
43+
You can download the code, compile, install, and deploy to try it out (you can refer to the compilation documentation to see if it works as you expected). If there are any issues, you can directly contact us, submit an Issue, or fix it yourself by reading and analyzing the source code. For more details, see[Contribution](#contribution)
44+
45+
Whether it's fixing a bug or adding a feature, we warmly welcome it. If you wish to submit code to Doris, you need to fork the code repository to your project space on GitHub, create a new branch for your submitted code, add the original project as an upstream, and submit a PR. The method for submitting a PR can be referenced in the Pull Request documentation.
46+
47+
48+
## Issue Type
49+
Issues can be categorized into three types:
50+
- Bug: Issues where code or execution examples contain bugs or lack dependencies, resulting in incorrect execution.
51+
- Documentation: Discrepancies in documentation, inconsistencies between documentation content and code, etc.
52+
- Feature: New functionalities that evolve from the current codebase.
53+
54+
## Issue Template
55+
### Issue: Bug Template
56+
57+
**Checklist before submitting an issue**
58+
<br>Please confirm that you have checked the document, issues, discussions (GitHub feature), and other publicly available documentation.
59+
- I have searched through all documentation related to Codefuse.
60+
- I used GitHub search to find a similar issue, but did not find one.
61+
- I have added a very descriptive title for this issue.
62+
63+
**System Information**
64+
<br>Please confirm your operating system, such as mac-xx, windows-xx, linux-xx.
65+
66+
**Code Version**
67+
<br>Please confirm the code version or branch, such as master, release, etc.
68+
69+
**Problem Description**
70+
<br>Describe the problem you encountered, what you want to achieve, or the bug encountered during code execution.
71+
72+
**Code Example**
73+
<br>Attach your execution code and relevant configuration to facilitate rapid intervention and reproduction.
74+
75+
**Error Information, Logs**
76+
<br>The error logs and related information after executing the above code example.
77+
78+
**Related Dependencies**
79+
<br>Taking the chatbot project as an example:
80+
- connector
81+
- codechat
82+
- sandbox
83+
- ...
84+
85+
86+
### Issue: Documentation Template
87+
88+
**Issue with current documentation:**
89+
<br>Please point out any problems, typos, or confusing points in the current documentation.
90+
91+
**Idea or request for content**
92+
<br>What do you think would be a reasonable way to express the documentation?
93+
94+
### Issue: Feature Template
95+
96+
**Checklist before submitting an issue**
97+
<br>Please confirm that you have checked the document, issues, discussions (GitHub feature), and other publicly available documentation.
98+
- I have searched through all documentation related to Codefuse.
99+
- I used GitHub Issue search to find a similar issue, but did not find one.
100+
- I have added a very descriptive title for this issue.
101+
102+
**Feature Description**
103+
<br>Describe the purpose of this feature.
104+
105+
**Related Examples**
106+
<br>Provide references to documents, repositories, etc., Please provide links to any relevant GitHub repos, papers, or other resources if relevant.
107+
108+
**Motivation**
109+
<br>Describe the motivation for this feature. Why is it needed? Provide enough context information to help understand the demand for this feature.
110+
111+
**Contribution**
112+
<br>How you can contribute to the building of this feature (if you are participating).
113+
114+
115+
116+
## Contribution
117+
118+
### Pre-Checklist
119+
- First, confirm whether you have checked the document, issue, discussion (GitHub features), or other publicly available documentation.
120+
- Find the GitHub issue you want to address. If none exists, create an issue or draft PR and ask a Maintainer for a check
121+
- Check for related, similar, or duplicate pull requests
122+
- Create a draft pull request
123+
- Complete the PR template for the description
124+
- Link any GitHub issue(s) that are resolved by your PR
125+
126+
### Description
127+
128+
A description of the PR should be articulated in concise language, highlighting the work completed by the PR. See specific standards at[Commit Format Specification](#Commit-Format-Specification)
129+
130+
### Related Issue
131+
#xx if has
132+
133+
### Test Code with Result
134+
Please provide relevant test code when necessary.
135+
136+
137+
138+
## Commit Format Specification
139+
A commit consists of a "title" and a "body." The title should generally be in lowercase, while the first letter of the body should be uppercase.
140+
141+
### Title
142+
The title of the commit message: `[<type>](<scope>) <subject> (#pr)`
143+
144+
145+
### Type - Available Options
146+
147+
本次提交的类型，限定在以下类型（全小写）
148+
- fix: Bug fixes
149+
- feature: New features
150+
- feature-wip: Features that are currently in development, such as partial code for a function.
151+
- improvement: Optimizations and improvements to existing features
152+
- style: Adjustments to code style
153+
- typo: Typographical errors in code or documentation
154+
- refactor: Code refactoring (without changing functionality)
155+
- performance/optimize: Performance optimization
156+
- test: Addition or fix of unit tests
157+
- deps: Modifications to third-party dependencies
158+
- community: Community-related changes, such as modifying Github Issue templates, etc.
159+
160+
Please note:
161+
162+
If multiple types occur in one commit, add multiple types.
163+
164+
If code refactoring leads to performance improvement, both [refactor][optimize] can be added.
165+
166+
Other types not listed above should not appear. If necessary, new types must be added to this document.
167+
168+
### Scope - Available Options
169+
The scope of the modules involved in the current submission. Due to the multitude of functional modules, only a few are listed here, and this list will be updated continuously based on needs.
170+
171+
For example, using a chatbot framework:
172+
connector
173+
codechat
174+
sandbox
175+
...
176+
177+
Please note:
178+
179+
Try to use options that are already listed. If you need to add new ones, please update this document promptly.
180+
181+
### Subject Content
182+
The title should clearly indicate the main content of the current submission.
183+
184+
185+
## Example
186+
comming soon
187+
188+
189+
## Reference
190+
[doris-commit-format](https://doris.apache.org/zh-CN/community/how-to-contribute/commit-format-specification)

‎.github/ISSUE_TEMPLATE/bug.yml

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
name: "\U0001F41B Bug Report"
2+
description: Report a bug in Codefuse. To report a security issue, please instead use the security option below.
3+
labels: ["01 Bug Report"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thank you for taking the time to file a bug report.
9+
10+
Use this to report bugs in Codefuse.
11+
12+
If you're not certain that your issue is due to a bug in Codefuse, please use [GitHub Discussions](https://github.com/codefuse-ai/codefuse-chatbot/discussions)
13+
to ask for help with your issue.
14+
15+
We warmly welcome any suggestions, opinions (including criticisms), comments, and contributions to the Codefuse project.
16+
17+
Relevant links to check before filing a bug report to see if your issue has already been reported, fixed or
18+
if there's another way to solve your problem:
19+
20+
[API Reference](https://codefuse-ai.github.io/),
21+
[GitHub search](https://github.com/codefuse-ai/codefuse-chatbot),
22+
[Chatbot Github Discussions](https://github.com/codefuse-ai/codefuse-chatbot/discussions),
23+
[Chatbot Github Issues](https://github.com/codefuse-ai/codefuse-chatbot/issues)
24+
25+
- type: checkboxes
26+
id: checks
27+
attributes:
28+
label: Checked other resources
29+
description: Please confirm and check all the following options.
30+
options:
31+
- label: I searched the Codefuse documentation with the integrated search.
32+
required: true
33+
- label: I used the GitHub search to find a similar question and didn't find it.
34+
required: true
35+
- label: I am sure that this is a bug in Codefuse-Repos rather than my code.
36+
required: true
37+
- label: I added a very descriptive title to this issue.
38+
required: true
39+
40+
- type: dropdown
41+
id: system-info
42+
attributes:
43+
label: System Info
44+
description: >
45+
Please select the operating system you were using to run codefuse-ai/repos when this problem occurred.
46+
options:
47+
- Windows
48+
- Linux
49+
- MacOS
50+
- Docker
51+
- Devcontainer / Codespace
52+
- Windows Subsystem for Linux (WSL)
53+
- Other
54+
validations:
55+
required: true
56+
nested_fields:
57+
- type: text
58+
attributes:
59+
label: Specify the system
60+
description: Please specify the system you are working on.
61+
62+
- type: dropdown
63+
attributes:
64+
label: Code Version
65+
description: |
66+
Please select which version of Codefuse-Repos you were using when this issue occurred.
67+
**If you weren't please try with the **.
68+
If installed with git you can run `git branch` to see which version of codefuse-ai you are running.
69+
options:
70+
- Latest Release
71+
- Stable (branch)
72+
- Master (branch)
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: description
78+
attributes:
79+
label: Description
80+
description: |
81+
What is the problem, question, or error?
82+
83+
Write a short description telling what you are doing, what you expect to happen, and what is currently happening.
84+
placeholder: |
85+
* I'm trying to use the `coagent` library to do X.
86+
* I expect to see Y.
87+
* Instead, it does Z.
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
id: reproduction
93+
validations:
94+
required: true
95+
attributes:
96+
label: Example Code
97+
description: |
98+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
99+
100+
If a maintainer can copy it, run it, and see it right away, there's a much higher chance that you'll be able to get help.
101+
102+
**Important!**
103+
104+
* Use code tags (e.g., ```python ... ```) to correctly [format your code](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting).
105+
* INCLUDE the language label (e.g. `python`) after the first three backticks to enable syntax highlighting. (e.g., ```python rather than ```).
106+
* Reduce your code to the minimum required to reproduce the issue if possible. This makes it much easier for others to help you.
107+
* Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
108+
109+
placeholder: |
110+
The following code:
111+
112+
```python
113+
from coagent.tools import toLangchainTools, TOOL_DICT, TOOL_SETS
114+
from coagent.connector.phase import BasePhase
115+
from coagent.connector.schema import Message
116+
117+
phase_name = "baseGroupPhase"
118+
phase = BasePhase(
119+
phase_name, embed_config=embed_config, llm_config=llm_config,
120+
)
121+
122+
query_content = "确认本地是否存在employee_data.csv，并查看它有哪些列和数据类型;然后画柱状图"
123+
query = Message(
124+
role_name="human", role_type="user", tools=[],
125+
role_content=query_content, input_query=query_content, origin_query=query_content,
126+
)
127+
128+
output_message, output_memory = phase.step(query)
129+
```
130+
131+
- type: textarea
132+
id: error
133+
validations:
134+
required: false
135+
attributes:
136+
label: Error Message and Stack Trace (if applicable)
137+
description: |
138+
If you are reporting an error, please include the full error message and stack trace.
139+
placeholder: |
140+
Exception + full stack trace

‎.github/ISSUE_TEMPLATE/documentation.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Documentation
2+
description: Report an issue related to the Codefuse documentation.
3+
title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
4+
labels: [02 - Documentation]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: "Issue with current documentation:"
10+
description: >
11+
Please make sure to leave a reference to the document/code you're
12+
referring to.
13+
14+
- type: textarea
15+
attributes:
16+
label: "Idea or request for content:"
17+
description: >
18+
Please describe as clearly as possible what topics you think are missing
19+
from the current documentation.

‎.github/ISSUE_TEMPLATE/features.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature request 🚀
2+
description: Suggest a new idea for Codefuse!
3+
labels: ['03 New Features']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
First, check out our [wiki page on Contributing](https://github.com/Significant-Gravitas/Nexus/wiki/Contributing)
9+
Please provide a searchable summary of the issue in the title above ⬆️.
10+
- type: checkboxes
11+
attributes:
12+
label: Duplicates
13+
description: Please [search the history](https://github.com/Significant-Gravitas/AutoGPT/issues) to see if an issue already exists for the same problem.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
18+
19+
- type: checkboxes
20+
id: checks
21+
attributes:
22+
label: Checked other resources
23+
description: Please confirm and check all the following options.
24+
options:
25+
- label: I searched the Codefuse documentation with the integrated search.
26+
required: true
27+
- label: I used the GitHub search to find a similar question and didn't find it.
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Summary 💡
33+
description: Describe how it should work.
34+
35+
- type: textarea
36+
attributes:
37+
label: Examples 🌈
38+
description: Provide a link to other implementations, or screenshots of the expected behavior.
39+
40+
- type: textarea
41+
attributes:
42+
label: Motivation 🔦
43+
description: What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world.

‎.github/PULL_REQUEST_TEMPLATE.md

Whitespace-only changes.

0 commit comments

Comments
 (0)