From f0c1103b10856deefedd1498f28d484ae86700cb Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:37:00 -0700 Subject: [PATCH 01/14] Add explaination of IDE design process and include template --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 36 ++++++++++++++++++++ docs/contributing/ide_design_process.md | 20 +++++++++++ 2 files changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-suggestion.md create mode 100644 docs/contributing/ide_design_process.md diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md new file mode 100644 index 0000000000000..f70df4fc8103d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -0,0 +1,36 @@ +--- +name: Feature suggestion +about: Propose a new feature +title: '' +labels: [Feature Request, Area-IDE] +assignees: '' +--- + + + +## Summary + + + +## Background and Motivation + + + +## Proposed Feature + + + +## Alternative Designs + + diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md new file mode 100644 index 0000000000000..c28c62b83b7d0 --- /dev/null +++ b/docs/contributing/ide_design_process.md @@ -0,0 +1,20 @@ +# IDE Team Design Process + +## Discussions / Issues + +The goal is that folks can create and discuss feature suggestions without needing to have verything fully figured out. Feel free to file a new feature suggestion and members of the oslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, hese feature suggestions won't be discussed until we have a proposal written for them. + +## Proposals + +### Adding a proposal + +For a feature proposal to be reviewed a design proposal needs be appended to the github ssue. It should have the following information: + +- **Summary**: Brief summary of what this proposal is about +- **Background and Motivation**: What the problem is we are solving and in what context did ou encounter it? +- **Proposed Feature**: How the proposed solution solves the problem +- **Alternative Designs**: Were there other options you considered? How does this compare to eatures in other editors? + +### Getting the issue championed by the IDE team + +A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](ttps://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these item. From 98ee83a6e225af9419dad0fcc272c61c19cbd851 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:49:02 -0700 Subject: [PATCH 02/14] fix some typos Co-authored-by: Joey Robichaud Co-authored-by: CyrusNajmabadi --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 2 +- docs/contributing/ide_design_process.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md index f70df4fc8103d..0a2042a5f3cf0 100644 --- a/.github/ISSUE_TEMPLATE/feature-suggestion.md +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -25,7 +25,7 @@ What the problem is we are solving and in what context did you encounter it? ## Proposed Feature ## Alternative Designs diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index c28c62b83b7d0..5f10e67fe093d 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -2,7 +2,7 @@ ## Discussions / Issues -The goal is that folks can create and discuss feature suggestions without needing to have verything fully figured out. Feel free to file a new feature suggestion and members of the oslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, hese feature suggestions won't be discussed until we have a proposal written for them. +The goal is that folks can create and discuss feature suggestions without needing to have everything fully figured out. Feel free to file a new feature suggestion and members of the Roslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, these feature suggestions won't be discussed until we have a proposal written for them. ## Proposals @@ -11,9 +11,9 @@ The goal is that folks can create and discuss feature suggestions without needin For a feature proposal to be reviewed a design proposal needs be appended to the github ssue. It should have the following information: - **Summary**: Brief summary of what this proposal is about -- **Background and Motivation**: What the problem is we are solving and in what context did ou encounter it? -- **Proposed Feature**: How the proposed solution solves the problem -- **Alternative Designs**: Were there other options you considered? How does this compare to eatures in other editors? +- **Background and Motivation**: What the problem is we are solving and in what context did you encounter it? +- **Proposed Feature**: How the proposed solution solves the problem? +- **Alternative Designs**: Were there other options you considered? How does this compare to features in other editors? ### Getting the issue championed by the IDE team From 1530e049b8913b6bd234f222f9dace2f66778d02 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:49:28 -0700 Subject: [PATCH 03/14] Apply suggestions from code review Co-authored-by: Joey Robichaud --- docs/contributing/ide_design_process.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 5f10e67fe093d..929bd39b7f841 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -8,9 +8,9 @@ The goal is that folks can create and discuss feature suggestions without needin ### Adding a proposal -For a feature proposal to be reviewed a design proposal needs be appended to the github ssue. It should have the following information: +For a feature proposal to be reviewed a design proposal needs be appended to the github issue. It should have the following information: -- **Summary**: Brief summary of what this proposal is about +- **Summary**: Brief summary of what this proposal is about. - **Background and Motivation**: What the problem is we are solving and in what context did you encounter it? - **Proposed Feature**: How the proposed solution solves the problem? - **Alternative Designs**: Were there other options you considered? How does this compare to features in other editors? From 63fa1aefa7db9f02c5ece5daf15686100195f553 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:49:46 -0700 Subject: [PATCH 04/14] Update .github/ISSUE_TEMPLATE/feature-suggestion.md Co-authored-by: Joey Robichaud --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md index 0a2042a5f3cf0..9c66c0b225f74 100644 --- a/.github/ISSUE_TEMPLATE/feature-suggestion.md +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -7,7 +7,7 @@ assignees: '' --- ## Summary From e529ebb1feabeac6230b2e9b4ddfbf42358c467a Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:52:07 -0700 Subject: [PATCH 05/14] Update feature-suggestion.md --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md index 9c66c0b225f74..2b13031f45da0 100644 --- a/.github/ISSUE_TEMPLATE/feature-suggestion.md +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -19,7 +19,7 @@ Brief summary of what this proposal is about. ## Background and Motivation ## Proposed Feature From c75f8dc994989e72c9d9eb3087948b40f0e9b1e8 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:53:24 -0700 Subject: [PATCH 06/14] Update .github/ISSUE_TEMPLATE/feature-suggestion.md Co-authored-by: Joey Robichaud --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md index 2b13031f45da0..9cc98c9541f26 100644 --- a/.github/ISSUE_TEMPLATE/feature-suggestion.md +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -19,7 +19,7 @@ Brief summary of what this proposal is about. ## Background and Motivation ## Proposed Feature From 97e6366b686617d8a1719260b155d5d64c61d1c3 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:56:01 -0700 Subject: [PATCH 07/14] Update docs/contributing/ide_design_process.md Co-authored-by: Joey Robichaud --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 929bd39b7f841..bbe820a0cdf60 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -11,7 +11,7 @@ The goal is that folks can create and discuss feature suggestions without needin For a feature proposal to be reviewed a design proposal needs be appended to the github issue. It should have the following information: - **Summary**: Brief summary of what this proposal is about. -- **Background and Motivation**: What the problem is we are solving and in what context did you encounter it? +- **Background and Motivation**: What is the problem we are solving and in what context did you encounter it? - **Proposed Feature**: How the proposed solution solves the problem? - **Alternative Designs**: Were there other options you considered? How does this compare to features in other editors? From 9dd6ffaf34456523b4c4a226305a7295903c7cd4 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 10:56:06 -0700 Subject: [PATCH 08/14] Update docs/contributing/ide_design_process.md Co-authored-by: Joey Robichaud --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index bbe820a0cdf60..2c68653d78b00 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -17,4 +17,4 @@ For a feature proposal to be reviewed a design proposal needs be appended to the ### Getting the issue championed by the IDE team -A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](ttps://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these item. +A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](ttps://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these issues. From 51dbf2516248d7e7e02e3a8984a693bdd9919701 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 13:40:51 -0700 Subject: [PATCH 09/14] Update docs/contributing/ide_design_process.md Co-authored-by: Youssef Victor --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 2c68653d78b00..9e9bfc83a64b8 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -8,7 +8,7 @@ The goal is that folks can create and discuss feature suggestions without needin ### Adding a proposal -For a feature proposal to be reviewed a design proposal needs be appended to the github issue. It should have the following information: +For a feature proposal to be reviewed, a design proposal needs be appended to the GitHub issue. It should have the following information: - **Summary**: Brief summary of what this proposal is about. - **Background and Motivation**: What is the problem we are solving and in what context did you encounter it? From 6bfd255ca0507ebc7c75fe16eadc4229f30b80ff Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 13:41:04 -0700 Subject: [PATCH 10/14] Update docs/contributing/ide_design_process.md Co-authored-by: Youssef Victor --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 9e9bfc83a64b8..66e6cb1ef220f 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -17,4 +17,4 @@ For a feature proposal to be reviewed, a design proposal needs be appended to th ### Getting the issue championed by the IDE team -A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](ttps://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these issues. +A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](https://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these issues. From 46d666dcbcf365838f45257cc4f2e32b84141b74 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 14:48:00 -0700 Subject: [PATCH 11/14] change 'folks' to 'contributors; --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 66e6cb1ef220f..c9bd5649dfee3 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -2,7 +2,7 @@ ## Discussions / Issues -The goal is that folks can create and discuss feature suggestions without needing to have everything fully figured out. Feel free to file a new feature suggestion and members of the Roslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, these feature suggestions won't be discussed until we have a proposal written for them. +The goal is that contributors can create and discuss feature suggestions without needing to have everything fully figured out. Feel free to file a new feature suggestion and members of the Roslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, these feature suggestions won't be discussed until we have a proposal written for them. ## Proposals From 9fa1902995a8f45df77c8b72bc9fdddbbac14fb6 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 14:48:51 -0700 Subject: [PATCH 12/14] change 'tries' to 'generally' --- docs/contributing/ide_design_process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index c9bd5649dfee3..57b4934dd0884 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -17,4 +17,4 @@ For a feature proposal to be reviewed, a design proposal needs be appended to th ### Getting the issue championed by the IDE team -A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](https://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team tries to meet once a week to discuss these issues. +A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](https://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team generally meets once a week to discuss these issues. From f7fbe19b8887c80c3f6c0c1d0564e4f536df17d5 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Tue, 7 Jun 2022 15:02:53 -0700 Subject: [PATCH 13/14] clarify language around proposals --- docs/contributing/ide_design_process.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/contributing/ide_design_process.md b/docs/contributing/ide_design_process.md index 57b4934dd0884..30c7f83d96fef 100644 --- a/docs/contributing/ide_design_process.md +++ b/docs/contributing/ide_design_process.md @@ -2,19 +2,21 @@ ## Discussions / Issues -The goal is that contributors can create and discuss feature suggestions without needing to have everything fully figured out. Feel free to file a new feature suggestion and members of the Roslyn-IDE team will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label. However, these feature suggestions won't be discussed until we have a proposal written for them. +The goal is that contributors can create and discuss feature suggestions without needing to have everything fully figured out. Feel free to file a new [Github issue](https://github.com/dotnet/roslyn/issues/new?assignees=&labels=Area-IDE%2CFeature+Request&template=feature-suggestion.md) or start a [discussion](https://github.com/dotnet/roslyn/discussions/new). These conversations can continue at their own pace until contributors feel ready to make a more formal proposal. ## Proposals ### Adding a proposal -For a feature proposal to be reviewed, a design proposal needs be appended to the GitHub issue. It should have the following information: +For a feature proposal to be reviewed, a Github issue needs to be created that has the following items in its description. If these aren't there to start they eventually need to be appended as a comment to the issue before its brought up for discussion. - **Summary**: Brief summary of what this proposal is about. - **Background and Motivation**: What is the problem we are solving and in what context did you encounter it? - **Proposed Feature**: How the proposed solution solves the problem? - **Alternative Designs**: Were there other options you considered? How does this compare to features in other editors? +Once you've added the details for your feature tag a member of the Roslyn-IDE team and they will add the "[Feature Request](https://github.com/dotnet/roslyn/issues?=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Feature+Request%22)" label to your Github issue. + ### Getting the issue championed by the IDE team -A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and add it to the "On Deck" tab in the [IDE Design Review](https://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team generally meets once a week to discuss these issues. +A member of [Roslyn-IDE](https://github.com/orgs/dotnet/teams/roslyn-ide) will need to decide to "champion" that feature proposal and bring it for discussion by adding it to the "On Deck" tab in the [IDE Design Review](https://github.com/dotnet/roslyn/projects/40) project. Behind the scenes the IDE Team generally meets once a week to discuss these issues. From 6699fe123eec2e2d3b8eb645fd5c29e9e5c74037 Mon Sep 17 00:00:00 2001 From: Jonathon Marolf Date: Wed, 8 Jun 2022 11:26:43 -0700 Subject: [PATCH 14/14] be specific that this is for IDE features --- .github/ISSUE_TEMPLATE/feature-suggestion.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.md b/.github/ISSUE_TEMPLATE/feature-suggestion.md index 9cc98c9541f26..d093dd8d5c459 100644 --- a/.github/ISSUE_TEMPLATE/feature-suggestion.md +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.md @@ -1,6 +1,6 @@ --- -name: Feature suggestion -about: Propose a new feature +name: IDE Feature suggestion +about: Propose a new IDE feature title: '' labels: [Feature Request, Area-IDE] assignees: ''