You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9c069e9
Browse filesBrowse the repository at this point in the historyBrowse files
docs: write contributor docs and templates in Simplified Technical English (Zoo-Code-Org#1987)
* chore: add Simplified Technical English reminders to PR and issue templates
* chore: add STE reminder to YAML issue forms
* chore: unify STE reminder wording and add title guidance
* chore: name ASD-STE100 and ban contractions in STE reminders
* docs: write contributor docs and templates in STE
* docs: sync contribution guides and codes of conduct for 17 locales
---------
Co-authored-by: zoomote[bot] <305051434+zoomote[bot]@users.noreply.github.com>
Co-authored-by: Elliott de Launay <[email protected]>
about: Add a provider model that is not in Zoo Code
4
4
title: ""
5
5
labels: model
6
6
assignees: ""
7
7
type: Task
8
8
---
9
9
10
+
<!-- Writing style: write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific. -->
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,28 +7,30 @@ assignees: ""
7
7
type: Bug
8
8
---
9
9
10
+
<!-- Writing style: write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific. -->
11
+
10
12
**Describe the bug**
11
-
A clear and concise description of what the bug is.
13
+
Describe the bug in one or two sentences.
12
14
13
15
**To Reproduce**
14
-
Steps to reproduce the behavior:
16
+
Write the steps that show the bug:
15
17
16
18
1. Go to '...'
17
19
2. Click on '....'
18
20
3. Scroll down to '....'
19
-
4.See error
21
+
4.Write the error you see
20
22
21
23
**Expected behavior**
22
-
A clear and concise description of what you expected to happen.
24
+
Describe what you expected to happen.
23
25
24
26
**Screenshots**
25
-
If applicable, add screenshots to help explain your problem.
27
+
Add screenshots if they help.
26
28
27
29
**Video**
28
-
Add a video of the incident happening, it will help us debug
30
+
Add a video of the bug. A video helps us find the cause.
29
31
30
32
**What version of zoo are you running**
31
-
i.e. 3.55
33
+
For example, 3.55
32
34
33
35
**Additional context**
34
-
Add any other context about the problem here.
36
+
Add any other facts about the problem. Include exact logs and error messages.
Write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific.
13
+
12
14
- type: textarea
13
15
id: problem
14
16
attributes:
15
17
label: Problem (one or two sentences)
16
-
description: Describe what went wrong in plain language.
18
+
description: Describe what went wrong.
17
19
placeholder: 'Example: "Expected the task to start, but nothing happened and no message appeared."'
18
20
validations:
19
21
required: true
@@ -22,7 +24,7 @@ body:
22
24
id: context
23
25
attributes:
24
26
label: Context (who is affected and when)
25
-
description: Who sees this and in what situation? Keep it non-technical.
27
+
description: Who sees this bug, and when? Use plain words.
26
28
placeholder: 'Example: "Happens to new users when starting a run from the New Run page with dark theme enabled."'
27
29
validations:
28
30
required: true
@@ -31,7 +33,7 @@ body:
31
33
id: steps
32
34
attributes:
33
35
label: Reproduction steps
34
-
description: Provide clear, numbered steps so we can reproduce.
36
+
description: Write numbered steps that show the bug.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,16 @@ assignees: ""
7
7
type: Feature
8
8
---
9
9
10
+
<!-- Writing style: write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific. -->
11
+
10
12
**Is your feature request related to a problem? Please describe.**
11
-
A clear and concise description of what the problem is. Ex. I'm always frustrated when[...]
13
+
Describe the problem in one or two sentences. For example: I always have to[...]
12
14
13
15
**Describe the solution you'd like**
14
-
A clear and concise description of what you want to happen.
16
+
Describe what you want to happen.
15
17
16
-
**Describe alternatives you've considered**
17
-
A clear and concise description of any alternative solutions or features you've considered.
18
+
**Describe alternatives you considered**
19
+
Describe any other solutions you considered.
18
20
19
21
**Additional context**
20
-
Add any other context or screenshots about the feature request here.
description: Propose an improvement in plain language focused on user benefit
2
+
description: Propose an improvement in plain language that helps users
3
3
labels: ["enhancement"]
4
4
title: "[ENHANCEMENT] "
5
5
body:
6
6
- type: markdown
7
7
attributes:
8
8
value: |
9
-
Thank you for helping improve Zoo Code!
10
-
Please focus on the problem and the desired behavior in plain language.
9
+
Thank you for helping improve Zoo Code.
10
+
Describe the problem and the behavior you want.
11
+
12
+
Write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific.
11
13
12
14
- type: textarea
13
15
id: problem
14
16
attributes:
15
17
label: Problem (one or two sentences)
16
18
description: What problem are users facing?
17
-
placeholder: e.g., "Users often click Copy Run by mistake and duplicate runs unintentionally."
19
+
placeholder: For example, "Users often click Copy Run by mistake and duplicate runs unintentionally."
18
20
validations:
19
21
required: true
20
22
21
23
- type: textarea
22
24
id: context
23
25
attributes:
24
26
label: Context (who is affected and when)
25
-
description: Who encounters this and in what situation?
26
-
placeholder: e.g., "Happens when browsing the Runs list; most visible for new users."
27
+
description: Who has this problem, and when?
28
+
placeholder: For example, "Happens when browsing the Runs list. New users see it most."
27
29
validations:
28
30
required: true
29
31
30
32
- type: textarea
31
33
id: desired
32
34
attributes:
33
35
label: Desired behavior (conceptual, not technical)
34
-
description: Describe what should happen in simple terms.
35
-
placeholder: e.g., "Ask for confirmation before copying a run."
36
+
description: Describe what should happen in simple words.
37
+
placeholder: For example, "Ask for confirmation before copying a run."
36
38
validations:
37
39
required: true
38
40
39
41
- type: textarea
40
42
id: constraints
41
43
attributes:
42
44
label: Constraints / preferences (optional)
43
-
description: Any considerations like performance, accessibility, or UX expectations.
44
-
placeholder: e.g., "Keep it quick and unobtrusive; keyboard accessible."
45
+
description: Write any limits, such as performance, accessibility, or UX needs.
46
+
placeholder: For example, "Keep it quick and unobtrusive. Make it keyboard accessible."
45
47
46
48
- type: checkboxes
47
49
id: checklist
48
50
attributes:
49
51
label: Request checklist
50
52
options:
51
-
- label: I've searched existing Issues and Discussions for duplicates
53
+
- label: I searched the existing Issues and Discussions for duplicates
52
54
required: true
53
55
- label: This describes a specific problem with clear context and impact
54
56
required: true
@@ -57,20 +59,20 @@ body:
57
59
id: roo-code-tasks
58
60
attributes:
59
61
label: Zoo Code Task Links (optional)
60
-
description: If you explored this with Zoo Code, share public task links for context.
62
+
description: If you tried this with Zoo Code, paste public task links.
61
63
placeholder: Paste your Zoo Code share links here, one per line
62
64
63
65
- type: markdown
64
66
attributes:
65
67
value: |
66
68
---
67
-
Optional: You can stop here if you're just proposing the improvement.
69
+
Optional: You can stop here if you only propose the improvement.
68
70
69
71
- type: textarea
70
72
id: acceptance-criteria
71
73
attributes:
72
74
label: Acceptance criteria (optional)
73
-
description: Define what “working” looks like with specific, testable outcomes.
75
+
description: Describe what “working” means. Use specificoutcomes that you can test.
74
76
placeholder: |
75
77
Given [context]
76
78
When [user action]
@@ -82,10 +84,10 @@ body:
82
84
id: proposed-solution
83
85
attributes:
84
86
label: Proposed approach (optional)
85
-
description: If you have an idea, describe it briefly in plain language.
87
+
description: If you have an idea, describe it in a few plain sentences.
86
88
87
89
- type: textarea
88
90
id: risks
89
91
attributes:
90
92
label: Trade-offs / risks (optional)
91
-
description: Potential downsides or alternatives considered.
93
+
description: Write the possible downsides and the other options you considered.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/marketplace.yml
+10-8Lines changed: 10 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,13 @@
1
1
name: Marketplace Feedback
2
-
description: Report issues or suggest improvements for marketplace items (custom modes and MCP servers)
2
+
description: Report a problem or suggest an improvement for marketplace items (custom modes and MCP servers)
3
3
labels: ["marketplace"]
4
4
body:
5
5
- type: markdown
6
6
attributes:
7
7
value: |
8
-
**Thanks for your feedback!** Please check existing issues first: https://github.com/Zoo-Code-Org/Zoo-Code/issues
8
+
**Thank you for your feedback.** First, check the existing issues: https://github.com/Zoo-Code-Org/Zoo-Code/issues
9
+
10
+
Write in Simplified Technical English (ASD-STE100): short sentences, plain words, active voice, one idea per sentence, no contractions. Keep the title short and specific.
9
11
10
12
- type: dropdown
11
13
id: feedback-type
@@ -35,28 +37,28 @@ body:
35
37
id: item-name
36
38
attributes:
37
39
label: Item Name (if applicable)
38
-
placeholder: e.g., "Debug Mode", "Weather API Server", "Code Formatter"
40
+
placeholder: For example, "Debug Mode", "Weather API Server", "Code Formatter"
39
41
40
42
- type: textarea
41
43
id: description
42
44
attributes:
43
45
label: Description
44
-
description: What's the issue or what would you like to see?
45
-
placeholder: Clear description of the problem or suggestion
46
+
description: What is the problem, or what do you want to see?
47
+
placeholder: Describe the problem or the suggestion
46
48
validations:
47
49
required: true
48
50
49
51
- type: textarea
50
52
id: additional-info
51
53
attributes:
52
54
label: Additional Details (optional)
53
-
description: Steps to reproduce, expected behavior, screenshots, etc.
54
-
placeholder: Any other helpful information
55
+
description: Add steps to reproduce, expected behavior, screenshots, and so on.
56
+
placeholder: Any other helpful facts
55
57
56
58
- type: checkboxes
57
59
id: checklist
58
60
attributes:
59
61
label: Checklist
60
62
options:
61
-
- label: I've searched existing issues for duplicates
63
+
- label: I searched the existing issues for duplicates
0 commit comments