Skip to content

Commit 9c069e9

Browse files
zoomote[bot]edelauna
andauthored
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]>
1 parent af9d7e7 commit 9c069e9

43 files changed

Lines changed: 4021 additions & 2461 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
22
name: Add provider model
3-
about: Add a provider model that isn't htere
3+
about: Add a provider model that is not in Zoo Code
44
title: ""
55
labels: model
66
assignees: ""
77
type: Task
88
---
99

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+
1012
Name of model: (GPT 5.4)
11-
Model creator: (i.e. Open AI)
13+
Model creator: (for example, OpenAI)
1214
Link to model:

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,30 @@ assignees: ""
77
type: Bug
88
---
99

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+
1012
**Describe the bug**
11-
A clear and concise description of what the bug is.
13+
Describe the bug in one or two sentences.
1214

1315
**To Reproduce**
14-
Steps to reproduce the behavior:
16+
Write the steps that show the bug:
1517

1618
1. Go to '...'
1719
2. Click on '....'
1820
3. Scroll down to '....'
19-
4. See error
21+
4. Write the error you see
2022

2123
**Expected behavior**
22-
A clear and concise description of what you expected to happen.
24+
Describe what you expected to happen.
2325

2426
**Screenshots**
25-
If applicable, add screenshots to help explain your problem.
27+
Add screenshots if they help.
2628

2729
**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.
2931

3032
**What version of zoo are you running**
31-
i.e. 3.55
33+
For example, 3.55
3234

3335
**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.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
name: Bug Report
2-
description: Report a broken behavior in plain language with a minimal reproduction
2+
description: Report a bug in plain language with a minimal reproduction
33
labels: ["bug"]
44
title: "[BUG] "
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thank you for your report! Please search existing issues first:
9+
Thank you for your report. First, search the existing issues:
1010
https://github.com/Zoo-Code-Org/Zoo-Code/issues
1111
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.
13+
1214
- type: textarea
1315
id: problem
1416
attributes:
1517
label: Problem (one or two sentences)
16-
description: Describe what went wrong in plain language.
18+
description: Describe what went wrong.
1719
placeholder: 'Example: "Expected the task to start, but nothing happened and no message appeared."'
1820
validations:
1921
required: true
@@ -22,7 +24,7 @@ body:
2224
id: context
2325
attributes:
2426
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.
2628
placeholder: 'Example: "Happens to new users when starting a run from the New Run page with dark theme enabled."'
2729
validations:
2830
required: true
@@ -31,7 +33,7 @@ body:
3133
id: steps
3234
attributes:
3335
label: Reproduction steps
34-
description: Provide clear, numbered steps so we can reproduce.
36+
description: Write numbered steps that show the bug.
3537
placeholder: |
3638
1) Environment/setup (OS, extension version, relevant settings)
3739
2) Exact actions (clicks, inputs, commands)
@@ -43,30 +45,30 @@ body:
4345
id: expected
4446
attributes:
4547
label: Expected result
46-
placeholder: e.g., "The task starts and shows progress."
48+
placeholder: For example, "The task starts and shows progress."
4749
validations:
4850
required: true
4951

5052
- type: input
5153
id: actual
5254
attributes:
5355
label: Actual result
54-
placeholder: e.g., "The button appears disabled and no progress is shown."
56+
placeholder: For example, "The button appears disabled and no progress is shown."
5557
validations:
5658
required: true
5759

5860
- type: textarea
5961
id: variations
6062
attributes:
6163
label: Variations tried (optional)
62-
description: Different browsers, devices, providers, or settings you tried.
63-
placeholder: e.g., "Tried Chrome/Firefox, disabling dark theme, switching providers."
64+
description: Write the other browsers, devices, providers, or settings you tried.
65+
placeholder: For example, "Tried Chrome/Firefox, disabling dark theme, switching providers."
6466

6567
- type: input
6668
id: version
6769
attributes:
6870
label: App Version
69-
description: What version of Zoo Code are you using? (e.g., v3.3.1)
71+
description: Which version of Zoo Code do you use? (for example, v3.3.1)
7072
validations:
7173
required: true
7274

@@ -102,18 +104,18 @@ body:
102104
id: model
103105
attributes:
104106
label: Model Used (optional)
105-
description: Exact model name (e.g., Claude 3.7 Sonnet). Use N/A if irrelevant.
107+
description: Write the exact model name (for example, Claude 3.7 Sonnet). Write N/A if it does not apply.
106108

107109
- type: textarea
108110
id: roo-code-tasks
109111
attributes:
110112
label: Zoo Code Task Links (optional)
111-
description: If you have any publicly shared Zoo Code task links that demonstrate the issue, paste them here.
113+
description: Paste any public Zoo Code task links that show the issue.
112114
placeholder: Paste your Zoo Code share links here, one per line
113115

114116
- type: textarea
115117
id: logs
116118
attributes:
117119
label: Relevant logs or errors (optional)
118-
description: Paste relevant output or errors. Use triple backticks (```) for formatting.
120+
description: Paste the exact output or errors. Do not change them. Use triple backticks (```) for formatting.
119121
render: shell

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ assignees: ""
77
type: Feature
88
---
99

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+
1012
**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 [...]
1214

1315
**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.
1517

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.
1820

1921
**Additional context**
20-
Add any other context or screenshots about the feature request here.
22+
Add any other facts or screenshots.
Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,56 @@
11
name: Enhancement Request
2-
description: Propose an improvement in plain language focused on user benefit
2+
description: Propose an improvement in plain language that helps users
33
labels: ["enhancement"]
44
title: "[ENHANCEMENT] "
55
body:
66
- type: markdown
77
attributes:
88
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.
1113
1214
- type: textarea
1315
id: problem
1416
attributes:
1517
label: Problem (one or two sentences)
1618
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."
1820
validations:
1921
required: true
2022

2123
- type: textarea
2224
id: context
2325
attributes:
2426
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."
2729
validations:
2830
required: true
2931

3032
- type: textarea
3133
id: desired
3234
attributes:
3335
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."
3638
validations:
3739
required: true
3840

3941
- type: textarea
4042
id: constraints
4143
attributes:
4244
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."
4547

4648
- type: checkboxes
4749
id: checklist
4850
attributes:
4951
label: Request checklist
5052
options:
51-
- label: I've searched existing Issues and Discussions for duplicates
53+
- label: I searched the existing Issues and Discussions for duplicates
5254
required: true
5355
- label: This describes a specific problem with clear context and impact
5456
required: true
@@ -57,20 +59,20 @@ body:
5759
id: roo-code-tasks
5860
attributes:
5961
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.
6163
placeholder: Paste your Zoo Code share links here, one per line
6264

6365
- type: markdown
6466
attributes:
6567
value: |
6668
---
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.
6870
6971
- type: textarea
7072
id: acceptance-criteria
7173
attributes:
7274
label: Acceptance criteria (optional)
73-
description: Define what “working” looks like with specific, testable outcomes.
75+
description: Describe what “working” means. Use specific outcomes that you can test.
7476
placeholder: |
7577
Given [context]
7678
When [user action]
@@ -82,10 +84,10 @@ body:
8284
id: proposed-solution
8385
attributes:
8486
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.
8688

8789
- type: textarea
8890
id: risks
8991
attributes:
9092
label: Trade-offs / risks (optional)
91-
description: Potential downsides or alternatives considered.
93+
description: Write the possible downsides and the other options you considered.

‎.github/ISSUE_TEMPLATE/marketplace.yml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
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)
33
labels: ["marketplace"]
44
body:
55
- type: markdown
66
attributes:
77
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.
911
1012
- type: dropdown
1113
id: feedback-type
@@ -35,28 +37,28 @@ body:
3537
id: item-name
3638
attributes:
3739
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"
3941

4042
- type: textarea
4143
id: description
4244
attributes:
4345
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
4648
validations:
4749
required: true
4850

4951
- type: textarea
5052
id: additional-info
5153
attributes:
5254
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
5557

5658
- type: checkboxes
5759
id: checklist
5860
attributes:
5961
label: Checklist
6062
options:
61-
- label: I've searched existing issues for duplicates
63+
- label: I searched the existing issues for duplicates
6264
required: true

0 commit comments

Comments
 (0)