Skip to content

Add guidance on Feature Requests vs. Detailed Feature Proposals in contributing guidelines #4293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add guidance on Feature Requests vs. Detailed Feature Proposals in contributing guidelines #4293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Roo Code is a community-driven project, and we deeply value every contribution.

- [Before You Contribute](#before-you-contribute)
- [Finding & Planning Your Contribution](#finding--planning-your-contribution)
- [Feature Requests vs. Detailed Feature Proposals](#feature-requests-vs-detailed-feature-proposals)
- [Development & Submission Process](#development--submission-process)
- [Legal](#legal)

Expand Down Expand Up @@ -63,7 +64,7 @@ All contributions must begin with a GitHub Issue.
- **Check existing issues**: Search [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
- **Create an issue**: Use appropriate templates:
- **Bugs:** "Bug Report" template.
- **Features:** "Detailed Feature Proposal" template. Approval required before starting.
- **Features:** "Detailed Feature Proposal" template. Approval required before starting. (See [Feature Requests vs. Detailed Feature Proposals](#feature-requests-vs-detailed-feature-proposals) below)
- **Claim issues**: Comment and await official assignment.

**PRs without approved issues may be closed.**
Expand All @@ -79,6 +80,46 @@ All contributions must begin with a GitHub Issue.
- Create new bugs using the ["Bug Report" template](https://github.com/RooCodeInc/Roo-Code/issues/new/choose).
- **Security issues**: Report privately via [security advisories](https://github.com/RooCodeInc/Roo-Code/security/advisories/new).

### Feature Requests vs. Detailed Feature Proposals

Understanding the difference between these two submission types is crucial for choosing the right approach:

#### Feature Request (GitHub Discussions)

**Purpose**: Share general ideas or suggestions without detailed planning.

**How to Submit**:

- Navigate to [GitHub Discussions - Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests)
- Or click the "Feature Request" link when pressing the "New Issue" button in the issues section

**Use this when**:

- Your idea isn't fully developed yet
- You'd like community input or feedback
- You're proposing ideas without plans to implement them personally

#### Detailed Feature Proposal (GitHub Issues)

**Purpose**: Clearly outlined features intended for immediate implementation after approval.

**How to Submit**:

- Navigate to [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues)
- Click "New Issue" and select the "Detailed Feature Proposal" template

**Use this when**:

- Your feature is thoroughly planned and ready for approval
- You or someone else intends to implement the feature soon
- Formal approval is needed before starting development

**Note**: Detailed Feature Proposals must be approved and assigned by a maintainer before beginning implementation, as mentioned in the [Issue-First Approach](#issue-first-approach) section above.

![Issue Template Selection](placeholder-for-issue-template-selection-image)

**Important**: Choosing the wrong template might lead to your submission being redirected or closed. Do not use Bug Reports for feature ideas.

## Development & Submission Process

### Development Setup
Expand Down
43 changes: 42 additions & 1 deletion locales/ca/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Roo Code és un projecte impulsat per la comunitat i valorem molt cada contribuc

- [Abans de contribuir](#abans-de-contribuir)
- [Trobar i planificar la teva contribució](#trobar-i-planificar-la-teva-contribució)
- [Sol·licituds de funcionalitats vs. Propostes detallades de funcionalitats](#sol·licituds-de-funcionalitats-vs-propostes-detallades-de-funcionalitats)
- [Procés de desenvolupament i enviament](#procés-de-desenvolupament-i-enviament)
- [Legal](#legal)

Expand Down Expand Up @@ -63,7 +64,7 @@ Totes les contribucions han de començar amb una Issue de GitHub.
- **Revisar issues existents:** Cerca a [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
- **Crear una issue:** Utilitza les plantilles adequades:
- **Errors:** Plantilla "Bug Report".
- **Funcionalitats:** Plantilla "Detailed Feature Proposal". Es requereix aprovació abans de començar.
- **Funcionalitats:** Plantilla "Detailed Feature Proposal". Es requereix aprovació abans de començar. (Vegeu [Sol·licituds de funcionalitats vs. Propostes detallades de funcionalitats](#sol·licituds-de-funcionalitats-vs-propostes-detallades-de-funcionalitats) a continuació)
- **Reclamar issues:** Comenta i espera l'assignació oficial.

**Els PRs sense issues aprovades poden ser tancats.**
Expand All @@ -79,6 +80,46 @@ Totes les contribucions han de començar amb una Issue de GitHub.
- Crea nous informes d'errors utilitzant la [plantilla "Bug Report"](https://github.com/RooCodeInc/Roo-Code/issues/new/choose).
- **Vulnerabilitats de seguretat:** Informa de manera privada via [security advisories](https://github.com/RooCodeInc/Roo-Code/security/advisories/new).

### Sol·licituds de funcionalitats vs. Propostes detallades de funcionalitats

Entendre la diferència entre aquests dos tipus d'enviament és crucial per triar l'enfocament correcte:

#### Sol·licitud de funcionalitat (GitHub Discussions)

**Propòsit**: Compartir idees o suggeriments generals sense una planificació detallada.

**Com enviar**:

- Navega a [GitHub Discussions - Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests)
- O fes clic a l'enllaç "Feature Request" quan premis el botó "New Issue" a la secció d'issues

**Utilitza això quan**:

- La teva idea encara no està completament desenvolupada
- Vols comentaris o feedback de la comunitat
- Proposes idees sense plans d'implementar-les personalment

#### Proposta detallada de funcionalitat (GitHub Issues)

**Propòsit**: Funcionalitats clarament definides destinades a la implementació immediata després de l'aprovació.

**Com enviar**:

- Navega a [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues)
- Fes clic a "New Issue" i selecciona la plantilla "Detailed Feature Proposal"

**Utilitza això quan**:

- La teva funcionalitat està completament planificada i llesta per a l'aprovació
- Tu o algú altre té la intenció d'implementar la funcionalitat aviat
- Es necessita aprovació formal abans de començar el desenvolupament

**Nota**: Les Propostes detallades de funcionalitats han de ser aprovades i assignades per un mantenidor abans de començar la implementació, com es menciona a la secció [Enfoc Issue-First](#enfoc-issue-first) anterior.

![Selecció de plantilla d'Issue](placeholder-for-issue-template-selection-image)

**Important**: Triar la plantilla incorrecta pot fer que el teu enviament sigui redirigit o tancat. No utilitzis Informes d'errors per a idees de funcionalitats.

## Procés de desenvolupament i enviament

### Configuració de desenvolupament
Expand Down
43 changes: 42 additions & 1 deletion locales/de/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Roo Code ist ein Community-getriebenes Projekt, und wir schätzen jeden Beitrag

- [Bevor du beiträgst](#bevor-du-beiträgst)
- [Beitrag finden & planen](#beitrag-finden--planen)
- [Feature-Anfragen vs. Detaillierte Feature-Vorschläge](#feature-anfragen-vs-detaillierte-feature-vorschläge)
- [Entwicklung & Einreichung](#entwicklung--einreichung)
- [Rechtliches](#rechtliches)

Expand Down Expand Up @@ -63,7 +64,7 @@ Alle Beiträge müssen mit einem GitHub Issue beginnen.
- **Bestehende Issues prüfen**: Durchsuche die [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
- **Issue erstellen**: Nutze die passenden Vorlagen:
- **Bugs:** "Bug Report"-Vorlage.
- **Features:** "Detailed Feature Proposal"-Vorlage. Vor dem Start ist eine Genehmigung erforderlich.
- **Features:** "Detailed Feature Proposal"-Vorlage. Vor dem Start ist eine Genehmigung erforderlich. (Siehe [Feature-Anfragen vs. Detaillierte Feature-Vorschläge](#feature-anfragen-vs-detaillierte-feature-vorschläge) unten)
- **Issues beanspruchen**: Kommentiere und warte auf die offizielle Zuweisung.

**PRs ohne genehmigte Issues können geschlossen werden.**
Expand All @@ -79,6 +80,46 @@ Alle Beiträge müssen mit einem GitHub Issue beginnen.
- Erstelle neue Bug-Reports mit der ["Bug Report"-Vorlage](https://github.com/RooCodeInc/Roo-Code/issues/new/choose).
- **Sicherheitslücken:** Melde diese privat über [Security Advisories](https://github.com/RooCodeInc/Roo-Code/security/advisories/new).

### Feature-Anfragen vs. Detaillierte Feature-Vorschläge

Das Verständnis des Unterschieds zwischen diesen beiden Einreichungstypen ist entscheidend für die Wahl des richtigen Ansatzes:

#### Feature-Anfrage (GitHub Discussions)

**Zweck**: Allgemeine Ideen oder Vorschläge ohne detaillierte Planung teilen.

**Wie einreichen**:

- Navigiere zu [GitHub Discussions - Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests)
- Oder klicke auf den "Feature Request"-Link, wenn du den "New Issue"-Button im Issues-Bereich drückst

**Verwende dies wenn**:

- Deine Idee noch nicht vollständig ausgearbeitet ist
- Du Community-Input oder Feedback möchtest
- Du Ideen vorschlägst, ohne sie persönlich umsetzen zu wollen

#### Detaillierter Feature-Vorschlag (GitHub Issues)

**Zweck**: Klar umrissene Features, die nach Genehmigung sofort umgesetzt werden sollen.

**Wie einreichen**:

- Navigiere zu [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues)
- Klicke auf "New Issue" und wähle die "Detailed Feature Proposal"-Vorlage

**Verwende dies wenn**:

- Dein Feature vollständig durchdacht und bereit für die Genehmigung ist
- Du oder jemand anderes beabsichtigt, das Feature bald umzusetzen
- Eine formelle Genehmigung vor Entwicklungsbeginn benötigt wird

**Hinweis**: Detaillierte Feature-Vorschläge müssen von einem Maintainer genehmigt und zugewiesen werden, bevor mit der Implementierung begonnen wird, wie im obigen Abschnitt [Issue-First-Ansatz](#issue-first-ansatz) erwähnt.

![Issue-Vorlagen-Auswahl](placeholder-for-issue-template-selection-image)

**Wichtig**: Die Wahl der falschen Vorlage kann dazu führen, dass deine Einreichung umgeleitet oder geschlossen wird. Verwende keine Bug-Reports für Feature-Ideen.

## Entwicklung & Einreichung

### Entwicklungs-Setup
Expand Down
43 changes: 42 additions & 1 deletion locales/es/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Roo Code es un proyecto impulsado por la comunidad, y valoramos profundamente ca

- [Antes de Contribuir](#antes-de-contribuir)
- [Encontrar y Planificar tu Contribución](#encontrar-y-planificar-tu-contribución)
- [Solicitudes de Funciones vs. Propuestas Detalladas de Funciones](#solicitudes-de-funciones-vs-propuestas-detalladas-de-funciones)
- [Proceso de Desarrollo y Envío](#proceso-de-desarrollo-y-envío)
- [Legal](#legal)

Expand Down Expand Up @@ -63,7 +64,7 @@ Todas las contribuciones deben comenzar con un Issue de GitHub.
- **Revisar issues existentes**: Busca en [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
- **Crear un issue**: Usa las plantillas apropiadas:
- **Errores:** Plantilla "Bug Report".
- **Funciones:** Plantilla "Detailed Feature Proposal". Se requiere aprobación antes de comenzar.
- **Funciones:** Plantilla "Detailed Feature Proposal". Se requiere aprobación antes de comenzar. (Ver [Solicitudes de Funciones vs. Propuestas Detalladas de Funciones](#solicitudes-de-funciones-vs-propuestas-detalladas-de-funciones) abajo)
- **Reclamar issues**: Comenta y espera la asignación oficial.

**Los PRs sin issues aprobados pueden ser cerrados.**
Expand All @@ -79,6 +80,46 @@ Todas las contribuciones deben comenzar con un Issue de GitHub.
- Crea nuevos reportes de errores usando la [plantilla "Bug Report"](https://github.com/RooCodeInc/Roo-Code/issues/new/choose).
- **Problemas de seguridad**: Reporta de forma privada a través de [security advisories](https://github.com/RooCodeInc/Roo-Code/security/advisories/new).

### Solicitudes de Funciones vs. Propuestas Detalladas de Funciones

Comprender la diferencia entre estos dos tipos de envío es crucial para elegir el enfoque correcto:

#### Solicitud de Función (GitHub Discussions)

**Propósito**: Compartir ideas o sugerencias generales sin planificación detallada.

**Cómo enviar**:

- Navega a [GitHub Discussions - Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests)
- O haz clic en el enlace "Feature Request" al presionar el botón "New Issue" en la sección de issues

**Usa esto cuando**:

- Tu idea aún no está completamente desarrollada
- Quieres comentarios o retroalimentación de la comunidad
- Estás proponiendo ideas sin planes de implementarlas personalmente

#### Propuesta Detallada de Función (GitHub Issues)

**Propósito**: Funciones claramente delineadas destinadas a implementación inmediata después de la aprobación.

**Cómo enviar**:

- Navega a [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues)
- Haz clic en "New Issue" y selecciona la plantilla "Detailed Feature Proposal"

**Usa esto cuando**:

- Tu función está completamente planificada y lista para aprobación
- Tú o alguien más tiene la intención de implementar la función pronto
- Se necesita aprobación formal antes de comenzar el desarrollo

**Nota**: Las Propuestas Detalladas de Funciones deben ser aprobadas y asignadas por un mantenedor antes de comenzar la implementación, como se menciona en la sección [Enfoque Issue-First](#enfoque-issue-first) anterior.

![Selección de Plantilla de Issue](placeholder-for-issue-template-selection-image)

**Importante**: Elegir la plantilla incorrecta puede hacer que tu envío sea redirigido o cerrado. No uses Reportes de Errores para ideas de funciones.

## Proceso de Desarrollo y Envío

### Configuración de Desarrollo
Expand Down
43 changes: 42 additions & 1 deletion locales/fr/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Roo Code est un projet porté par la communauté, et chaque contribution compte

- [Avant de contribuer](#avant-de-contribuer)
- [Trouver et planifier ta contribution](#trouver-et-planifier-ta-contribution)
- [Demandes de fonctionnalités vs. Propositions détaillées de fonctionnalités](#demandes-de-fonctionnalités-vs-propositions-détaillées-de-fonctionnalités)
- [Processus de développement et de soumission](#processus-de-développement-et-de-soumission)
- [Légal](#légal)

Expand Down Expand Up @@ -63,7 +64,7 @@ Toutes les contributions doivent commencer par un ticket GitHub.
- **Vérifier les tickets existants :** Cherche dans les [Issues GitHub](https://github.com/RooCodeInc/Roo-Code/issues).
- **Créer un ticket :** Utilise les modèles appropriés :
- **Bugs :** Modèle "Bug Report".
- **Fonctionnalités :** Modèle "Detailed Feature Proposal". Approbation requise avant de commencer.
- **Fonctionnalités :** Modèle "Detailed Feature Proposal". Approbation requise avant de commencer. (Voir [Demandes de fonctionnalités vs. Propositions détaillées de fonctionnalités](#demandes-de-fonctionnalités-vs-propositions-détaillées-de-fonctionnalités) ci-dessous)
- **Réclamer des tickets :** Commente et attends l'assignation officielle.

**Les PRs sans tickets approuvés peuvent être fermées.**
Expand All @@ -79,6 +80,46 @@ Toutes les contributions doivent commencer par un ticket GitHub.
- Crée de nouveaux rapports de bugs avec le [modèle "Bug Report"](https://github.com/RooCodeInc/Roo-Code/issues/new/choose).
- **Failles de sécurité :** Signale-les en privé via [security advisories](https://github.com/RooCodeInc/Roo-Code/security/advisories/new).

### Demandes de fonctionnalités vs. Propositions détaillées de fonctionnalités

Comprendre la différence entre ces deux types de soumission est crucial pour choisir la bonne approche :

#### Demande de fonctionnalité (GitHub Discussions)

**Objectif** : Partager des idées ou suggestions générales sans planification détaillée.

**Comment soumettre** :

- Navigue vers [GitHub Discussions - Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests)
- Ou clique sur le lien "Feature Request" en appuyant sur le bouton "New Issue" dans la section issues

**Utilise ceci quand** :

- Ton idée n'est pas encore entièrement développée
- Tu souhaites des commentaires ou du feedback de la communauté
- Tu proposes des idées sans avoir l'intention de les implémenter personnellement

#### Proposition détaillée de fonctionnalité (GitHub Issues)

**Objectif** : Fonctionnalités clairement définies destinées à une implémentation immédiate après approbation.

**Comment soumettre** :

- Navigue vers [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues)
- Clique sur "New Issue" et sélectionne le modèle "Detailed Feature Proposal"

**Utilise ceci quand** :

- Ta fonctionnalité est entièrement planifiée et prête pour l'approbation
- Toi ou quelqu'un d'autre a l'intention d'implémenter la fonctionnalité bientôt
- Une approbation formelle est nécessaire avant de commencer le développement

**Note** : Les Propositions détaillées de fonctionnalités doivent être approuvées et assignées par un mainteneur avant de commencer l'implémentation, comme mentionné dans la section [Approche Issue-First](#approche-issue-first) ci-dessus.

![Sélection du modèle d'issue](placeholder-for-issue-template-selection-image)

**Important** : Choisir le mauvais modèle peut entraîner la redirection ou la fermeture de ta soumission. N'utilise pas les rapports de bugs pour des idées de fonctionnalités.

## Processus de développement et de soumission

### Configuration du développement
Expand Down
Loading