Skip to content
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.

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

suggestion for issue template #757

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -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'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep my name out of this, please.

---

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
dsyme marked this conversation as resolved.
Show resolved Hide resolved
* [ ] the choice for tooling support should be based on ease of implementation in code formatter
dsyme marked this conversation as resolved.
Show resolved Hide resolved
* [ ] the choice for tooling output should be based on
* [ ] conserving original formatting but for specific predicate that makes code significantly less maintainable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sigh, this is again a very on the nose commentary of Gauthier.

Fantomas today does not preserve any of the existing code style. This won't change and I don't want this is in an issue template that suggests otherwise.

* [ ] 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once more, we Fantomas maintainers strongly object to additional settings! Merely proposing a PR doesn't grant you authority here. Modifying settings in Fantomas should only be considered as a final option, subject to approval by the maintainers.


# 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 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
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this empty file needed?

Empty file.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/other_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Other issue
about: Open an issue which does not belong to any categories above
title: ''
labels: [needs-triage]
assignees: ''

---
<!-- Please, provide a clear and concise description of what the problem is below: -->