Skip to content

Commit 802e72f

Browse files
0xToshii0xToshii
authored
new feature github template + readme (RooCodeInc#4211)
* constributing * nit * nit
1 parent 10a223f commit 802e72f

File tree

4 files changed

+154
-14
lines changed

4 files changed

+154
-14
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false
22
contact_links:
33
- name: ✨ Feature Request
44
url: https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop
55
about: Share and vote on feature requests for Cline
66
- name: 👋 Cline Discord
77
url: https://discord.gg/cline
88
about: Join our Discord community for discussions and support
9-
- name: ❓ Other Questions?
10-
url: https://x.com/sdrzn
11-
about: Contact the developer on X @sdrzn for other inquiries

‎.github/ISSUE_TEMPLATE/feature_proposal.yml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: 📝 Detailed Feature Proposal
2+
description: Propose a new feature or improvement
3+
labels: ["proposal"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Feature Proposal for Cline**
9+
10+
Thank you for creating a feature proposal for Cline! This template is for clear, actionable proposals that define a specific problem and a high-confidence solution. Please provide enough detail to enable fast prioritization, discussion, and execution.
11+
12+
Detailed proposals will be prioritized, while vague proposals may be closed or require extensive back and forth communication.
13+
14+
Before submitting:
15+
- Search existing [Issues](https://github.com/cline/cline/issues) and [Discussions](https://github.com/cline/cline/discussions) to avoid duplicates
16+
- Don’t start implementation until the proposal is reviewed and approved
17+
18+
- type: textarea
19+
id: problem-description
20+
attributes:
21+
label: What problem does this solve?
22+
description: |
23+
Describe the problem clearly from a user's point of view. Focus on why this matters, who it affects, and when it occurs.
24+
25+
✅ Solid:
26+
- "LLM provider returns 400 error when nearing the context window instead of truncating"
27+
- "Submit button is invisible in dark mode"
28+
29+
❌ Avoid:
30+
- "Performance is bad"
31+
- "UI needs work"
32+
33+
Your description should include:
34+
- Who is affected?
35+
- When does it happen?
36+
- What's the current vs expected behavior?
37+
- What is the impact?
38+
placeholder: Be specific about the problem, who it affects, and the impact.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: proposed-solution
44+
attributes:
45+
label: What’s the proposed solution?
46+
description: |
47+
Describe how the problem should be solved. Be specific about UX, system behavior, and any flows that would change.
48+
49+
✅ Solid:
50+
- "Add error handling immediately after attempting to create the llm stream and retry after manually truncating"
51+
- "Update button styling to ensure contrast in all themes"
52+
53+
❌ Avoid:
54+
- "Improve performance"
55+
- "Fix the bug"
56+
57+
Your solution should include:
58+
- What exactly will change?
59+
- How will users interact with it?
60+
- What’s the expected outcome?
61+
placeholder: Describe the proposed changes and how they solve the problem.
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: acceptance-criteria
67+
attributes:
68+
label: How will we know it works? (Acceptance Criteria)
69+
description: Define clear, testable success criteria.
70+
placeholder: Provide specific and testable conditions for success.
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: estimated-effort
76+
attributes:
77+
label: Estimated effort and complexity
78+
description: |
79+
Help us understand scope and risks. Include:
80+
81+
- Size estimate (XS/S/M/L/XL or hours/days)
82+
- Why this size? What’s technically involved?
83+
- Any tricky parts, refactors, or risks?
84+
- Performance or compatibility concerns?
85+
- Any dependencies on systems, teams, or libraries?
86+
placeholder: Size, reasoning, risks, and dependencies.
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: technical-considerations
92+
attributes:
93+
label: Technical considerations, tradeoffs, and/or risks (optional)
94+
description: |
95+
Include any technical context that helps us evaluate or implement the proposal more effectively.
96+
97+
You may include:
98+
- Architectural changes or required refactors
99+
- Performance implications or system-level impacts
100+
- Known limitations, risks, or tricky edge cases
101+
- Compatibility concerns or migration steps
102+
- Alternative approaches you considered and why they were not chosen
103+
- Dependencies on other systems, teams, or libraries
104+
- Were other approaches considered? Why is this one preferred?
105+
placeholder: Technical considerations, tradeoffs, and/or risks.
106+
107+
- type: textarea
108+
id: additional-context
109+
attributes:
110+
label: Additional context (optional)
111+
description: Diagrams, mockups, logs, links, or anything else that helps explain or justify the proposal.
112+
placeholder: Diagrams, mockups, logs, links, or anything else that helps explain or justify the proposal.
113+
114+
- type: checkboxes
115+
id: checklist
116+
attributes:
117+
label: Proposal checklist
118+
options:
119+
- label: I’ve checked for existing issues or related proposals
120+
required: true
121+
- label: I understand this needs review before implementation can start
122+
required: true
123+
124+
- type: checkboxes
125+
id: willingness-to-contribute
126+
attributes:
127+
label: Interested in implementing this?
128+
description: Optional
129+
options:
130+
- label: Yes, I’d like to help implement this feature

‎.github/pull_request_template.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
<!-- ⚠️ Important: Discussion Required Before PR (Community Contributors) -->
1+
<!--
2+
Thank you for contributing to Cline!
23
3-
**For community contributors, before submitting this PR, please ensure you have:**
4+
⚠️ Important: Before submitting this PR, please ensure you have:
5+
- Opened an issue and discussed your proposed changes with the community / contributors
6+
- Received approval from a core Cline contributor prior to proceeding with the implementation
7+
- Link the associated issue in the "Related Issue" section
48
5-
- [ ] **Opened an issue** to discuss your proposed changes with the community
6-
- [ ] **Received approval** from a core Cline contributor to proceed with the implementation
7-
- [ ] **Linked the issue below** in the "Related Issue" section
9+
Limited exceptions:
10+
Small bug fixes, typo corrections, minor wording improvements, or simple type fixes that don't change functionality may be submitted directly.
811
9-
**Exceptions:** Small bug fixes, typo corrections, minor wording improvements, or simple type fixes that don't change functionality may be submitted directly.
10-
11-
**Why this requirement?** We deeply appreciate all community contributions - they are the core reason we're able to operate successfully and keep innovating! We welcome community input and want to make it as easy as possible for people to submit quality work. This process helps our core maintainers review new ideas faster and saves contributor time by ensuring you have the go-ahead before spending time on implementation.
12-
13-
---
12+
Why this requirement?
13+
We deeply appreciate all community contributions - they are the core reason we're able to operate successfully and keep innovating! We welcome community input and want to make it as easy as possible for people to submit quality work. This process helps our core maintainers review new ideas faster and saves contributor time by ensuring you have the go-ahead before spending time on implementation.
14+
-->
1415

1516
### Related Issue
1617

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ We also welcome contributions to our [documentation](https://github.com/cline/cl
1818

1919
If you're planning to work on a bigger feature, please create a [feature request](https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) first so we can discuss whether it aligns with Cline's vision.
2020

21+
## Before Contributing
22+
23+
All contributions must begin with a GitHub Issue, unless the change is for small bug fixes, typo corrections, minor wording improvements, or simple type fixes that don't change functionality.
24+
25+
- **Check existing issues**: Search [GitHub Issues](https://github.com/cline/cline/issues).
26+
- **Create an issue**: Use appropriate templates:
27+
- **Bugs:** "Bug Report" template.
28+
- **Features:** "Detailed Feature Proposal" template. Approval from a core Cline contributor required before starting.
29+
- **Claim issues**: Comment your interest.
30+
31+
**PRs without approved issues may be closed.**
32+
2133
## Development Setup
2234

2335
1. **VS Code Extensions**

0 commit comments

Comments
 (0)