From 5fc7dbecbbbfa842813f544843fc4e7d39bafd1c Mon Sep 17 00:00:00 2001 From: Gauthier Segay Date: Sat, 2 Dec 2023 17:56:06 +0100 Subject: [PATCH 1/4] suggestion for issue template, to split code formatting / style guide with other meta issues related to processing RFCs --- ...de_formatting_guidelines_specific_issue.md | 43 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++ .../meta_fslang-design_repository_issue.md | 0 .github/ISSUE_TEMPLATE/other_issue.md | 9 ++++ 4 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/meta_fslang-design_repository_issue.md create mode 100644 .github/ISSUE_TEMPLATE/other_issue.md diff --git a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md new file mode 100644 index 00000000..fa3d3ef9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md @@ -0,0 +1,43 @@ +--- +name: Formatting or code style guidelines issue +about: Discuss editor / tooling formatting concerns and code style guidelines +title: '' +labels: [style-guide, under-discussion] +assignees: '@nojaf,@KathleenDollard,@dsyme' +--- + +Depending the concern being discussed, erase the other top sections and review/tick what applies the most. + +# Is your request about a feature in code formatting (using fantomas, .editorconfig, editors with formatting options)? + +Formatting infrastructure decision checklist: +* [ ] If this is code formatter discussion, please suggest a detailed list of settings names and their default values, with their behaviour +* [ ] the choice for tooling support should be based on ease of implementation in code formatter +* [ ] the choice for tooling output should be based on +** [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable +** [ ] maximizing uniformity of a specific construct across a particular codebase +* [ ] I would like to contribute testing the feature implementation as end user +* [ ] I would like to contribute unit tests so the tooling implementation covers my use cases +* [ ] I would like to contribute implementation +** [ ] pro-bono +** [ ] sponsored +** [ ] sponsoring +* [ ] The implementation requires the several options upfront (rather than just the most "agreed upon") [^1] +* [ ] This is something that is common place in other langauges (add items nested under this list with one language per line) +* [ ] There are examples of codeformatters settings in other languages / tooling available (add items nested under this list with one link per line), add screenshots to the description +* [ ] There are examples of codeformatters implementation available (add items nested under this list with one link per line) + +[^1] this is generally evaluated by the person implementing and the entity potentially sponsoring the work + +# Is your request about [official style guide](https://learn.microsoft.com/en-us/dotnet/fsharp/style-guide/) update? + +Style guide update adoption checklist: +* [ ] I have submitted a PR / Draft on docs repository +* [ ] A PR was merged about it on docs repository +* [ ] I want the community to debate and share perspectives +* [ ] This is higher level concern than formatting: +** [ ] soundness/robustness of F# code +** [ ] performance concerns +** [ ] approachability of code towards: +*** [ ] people debutting with programming languages +*** [ ] seasoned developers diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3f6bff8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issue_enabled: true +contact_links: + - name: F# Discussions + url: https://github.com/dotnet/fsharp/discussions + about: Please ask and answer questions about current language implementation here. + - name: F# Language Suggestions + url: https://github.com/fsharp/fslang-suggestions + about: Language features discussions that aren't approved nor have an RFC here. + - name: F# Language Design + url: https://github.com/fsharp/fslang-design/discussions + about: Language design RFCs discussions here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/meta_fslang-design_repository_issue.md b/.github/ISSUE_TEMPLATE/meta_fslang-design_repository_issue.md new file mode 100644 index 00000000..e69de29b diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md new file mode 100644 index 00000000..72eeff01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issue.md @@ -0,0 +1,9 @@ +--- +name: Other issue +about: Open an issue which does not belong to any categories above +title: '' +labels: [needs-triage] +assignees: '' + +--- + \ No newline at end of file From 02e61386d0c38a8398b4a0264c0d0feef070f176 Mon Sep 17 00:00:00 2001 From: Gauthier Segay Date: Sat, 2 Dec 2023 18:01:15 +0100 Subject: [PATCH 2/4] Update code_formatting_guidelines_specific_issue.md --- ...de_formatting_guidelines_specific_issue.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md index fa3d3ef9..277c9f28 100644 --- a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md +++ b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md @@ -14,14 +14,14 @@ Formatting infrastructure decision checklist: * [ ] If this is code formatter discussion, please suggest a detailed list of settings names and their default values, with their behaviour * [ ] the choice for tooling support should be based on ease of implementation in code formatter * [ ] the choice for tooling output should be based on -** [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable -** [ ] maximizing uniformity of a specific construct across a particular codebase + * [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable + * [ ] maximizing uniformity of a specific construct across a particular codebase * [ ] I would like to contribute testing the feature implementation as end user * [ ] I would like to contribute unit tests so the tooling implementation covers my use cases * [ ] I would like to contribute implementation -** [ ] pro-bono -** [ ] sponsored -** [ ] sponsoring + * [ ] pro-bono + * [ ] sponsored + * [ ] sponsoring * [ ] The implementation requires the several options upfront (rather than just the most "agreed upon") [^1] * [ ] This is something that is common place in other langauges (add items nested under this list with one language per line) * [ ] There are examples of codeformatters settings in other languages / tooling available (add items nested under this list with one link per line), add screenshots to the description @@ -33,11 +33,11 @@ Formatting infrastructure decision checklist: Style guide update adoption checklist: * [ ] I have submitted a PR / Draft on docs repository -* [ ] A PR was merged about it on docs repository +* [ ] A PR was merged about it on docs repository and I want to bring it to attention of the community * [ ] I want the community to debate and share perspectives * [ ] This is higher level concern than formatting: -** [ ] soundness/robustness of F# code -** [ ] performance concerns -** [ ] approachability of code towards: -*** [ ] people debutting with programming languages -*** [ ] seasoned developers + * [ ] soundness/robustness of F# code + * [ ] performance concerns + * [ ] approachability of code towards: + * [ ] people debutting with programming languages + * [ ] seasoned developers From d59e3695be4c716b86efb4719afcfb12d78eb95a Mon Sep 17 00:00:00 2001 From: Don Syme Date: Wed, 12 Jun 2024 13:51:07 +0100 Subject: [PATCH 3/4] Update .github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md Co-authored-by: Abel Braaksma --- .../ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md index 277c9f28..3c847682 100644 --- a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md +++ b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md @@ -11,7 +11,7 @@ Depending the concern being discussed, erase the other top sections and review/t # Is your request about a feature in code formatting (using fantomas, .editorconfig, editors with formatting options)? Formatting infrastructure decision checklist: -* [ ] If this is code formatter discussion, please suggest a detailed list of settings names and their default values, with their behaviour +* [ ] If this is a code formatter discussion, please suggest a detailed list of settings names and their default values, with their behaviour * [ ] the choice for tooling support should be based on ease of implementation in code formatter * [ ] the choice for tooling output should be based on * [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable From 2ed0842bff18f25de364340fae594c3e322d741b Mon Sep 17 00:00:00 2001 From: Don Syme Date: Wed, 12 Jun 2024 13:51:13 +0100 Subject: [PATCH 4/4] Update .github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md Co-authored-by: Abel Braaksma --- .../ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md index 3c847682..9b1b5c2c 100644 --- a/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md +++ b/.github/ISSUE_TEMPLATE/code_formatting_guidelines_specific_issue.md @@ -12,7 +12,7 @@ Depending the concern being discussed, erase the other top sections and review/t Formatting infrastructure decision checklist: * [ ] If this is a code formatter discussion, please suggest a detailed list of settings names and their default values, with their behaviour -* [ ] the choice for tooling support should be based on ease of implementation in code formatter +* [ ] the choice for tooling support should be based on ease of implementation in the code formatter * [ ] the choice for tooling output should be based on * [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable * [ ] maximizing uniformity of a specific construct across a particular codebase