Skip to content

.github: Migrate Markdown issue templates to YAML forms #69808

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

Merged
merged 4 commits into from
Nov 27, 2023

Conversation

AnthonyLatsis
Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis commented Nov 12, 2023

# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors

blank_issues_enabled: true
contact_links:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Very interested to hear your thoughts on what order of contact links makes the most sense.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "Ask" and "Report" links should be moved up and "Learn Swift" should be last?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Maybe "Ask" and "Report" links should be moved up

To the top, before "Discuss an idea" and "Formally propose a change"?

@benrimmington

This comment was marked as resolved.

@AnthonyLatsis
Copy link
Collaborator Author

AnthonyLatsis commented Nov 13, 2023

Spellcheck: "Begginer", "consice", "prefferably".

How embarrassing. Thank you!

  • 🪲 Report an issue on the Feedback Assistant app

Yeah, I guess redirection redundancy cannot hurt. I feel like most people won’t read through to this item and go straight for "Report a bug" though.

Is "on the app" really OK? Sounds a bit odd. Maybe "using"?

@AnthonyLatsis AnthonyLatsis force-pushed the migrate-to-issue-forms branch 3 times, most recently from 9beb9d1 to 51047f5 Compare November 13, 2023 19:26
Copy link
Member

@ahoppen ahoppen left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks!

Copy link
Contributor

@LucianoPAlmeida LucianoPAlmeida left a comment

Choose a reason for hiding this comment

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

This looks awesome!

Copy link
Member

@shahmishal shahmishal left a comment

Choose a reason for hiding this comment

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

Love it!

@AnthonyLatsis
Copy link
Collaborator Author

AnthonyLatsis commented Nov 14, 2023

Could someone help me out with capitalization? We are pretty inconsistent with how we capitalize most of the following compound nouns in all sorts of content from internal docs to TSPL and Swift.org, and I couldn’t find any helpful prescriptions in the Apple Style Guide. I’d like to get this right if possible.

  • Swift forums or Swift Forums?
  • Swift compiler or Swift Compiler?
  • Swift standard library or Swift Standard Library?
  • Swift runtime or Swift Runtime?
  • Swift language or Swift Language? The former, I guess, because the name of the language is Swift, not Swift Language.

Ordinary capitalization rules suggest that all except for the last are proper nouns and should be capitalized.

@AnthonyLatsis AnthonyLatsis force-pushed the migrate-to-issue-forms branch 2 times, most recently from 3bf1fa8 to 0366951 Compare November 14, 2023 17:30
@AnthonyLatsis
Copy link
Collaborator Author

I raised the capitalization question with the Contributor Experience Workgroup. We have consensus on "Swift Forums" and "Swift Standard Library", but are not as sure about the rest.

@amartini51 counting on you for a decisive opinion.

@amartini51
Copy link
Member

amartini51 commented Nov 17, 2023

I raised the capitalization question with the Contributor Experience Workgroup. We have consensus on "Swift Forums" and "Swift Standard Library", but are not as sure about the rest.

@amartini51 counting on you for a decisive opinion.

The documentation style guide calls for "Swift standard library". The word "Swift" is a proper noun, but the stdlib part of the name is not. I believe this matches the way many other languages refer to their standard libraries — although my memory might incorrect or partial, since those discussions were circa 2014. This one has specific guidance from the style guide because misspelling it as "Swift Standard Library" is common.

TSPL's local style guide has an entry for this:
https://github.com/apple/swift-book/blob/main/Style.md#standard-library

The style guidelines used within Apple's Developer Publications team has an entry too:

Swift standard library
Note capitalization. Use to refer to the standard library in Swift.

I don't have a specific style guide entry to point to for "Swift forums" but I would spell it with lowercase f for the same reason. All of these terms — the Swift compiler, the Swift standard library, the Swift forums, the Swift community — are ordinary nouns (common nouns in the writing sense) being modified by the word "Swift".

One quick check to help tell common & proper nouns apart is that proper nouns seldom have "a" or "the" in front of them in English — because a proper noun is a name of a specific thing, there's no need for the semantic disambiguation that articles provide. For example, "You wrote a great post in the Swift forums about this feature." is grammatical, but "... in Swift Forums about this..." is odd and stilted. Likewise we write "the Swift compiler" but not "the Swift" or "the Alex".

If there are places you're seeing these kinds of terms with incorrect capitalization, please do file a bug. This kind of mistake is easy to make.

@MaxDesiatov
Copy link
Contributor

MaxDesiatov commented Nov 20, 2023

https://forums.swift.org has this right at the top of the main page:

The Swift Forums are governed by the Swift Code of Conduct.

Does that mean that this PR should stick to that capitalization, or should we file a bug for Swift forums landing page to be updated?

@AnthonyLatsis
Copy link
Collaborator Author

AnthonyLatsis commented Nov 22, 2023

I don't have a specific style guide entry to point to for "Swift forums" but I would spell it with lowercase f for the same reason. All of these terms — the Swift compiler, the Swift standard library, the Swift forums, the Swift community — are ordinary nouns (common nouns in the writing sense) being modified by the word "Swift".

I definitely make "Swift community" as a common noun. As for the rest, I kind of get the point intuitively, but I doubt I could explain this properly to anyone in terms of rules. Also, the logic appears to suggest that "Swift Code of Conduct" is incorrectly capitalized.

One quick check to help tell common & proper nouns apart is that proper nouns seldom have "a" or "the" in front of them in English — because a proper noun is a name of a specific thing, there's no need for the semantic disambiguation that articles provide. For example, "You wrote a great post in the Swift forums about this feature." is grammatical, but "... in Swift Forums about this..." is odd and stilted. Likewise we write "the Swift compiler" but not "the Swift" or "the Alex".

Personally, I find it more reliable to check whether reformulating the noun as a possessive phrase works just as well, as in "the London Eye" vs. "the eye of London", where it certainly does not. To me it seems like compound nouns that end with a noun that is usually used with an article sound odd without an article in vernacular regardless of whether they are common or proper.


Anyway, thank you very much for helping out! I’m really glad to know we have a preferred capitalization for "Swift standard library" that can be extrapolated to similar productions. It would be awesome to eventually publish a subset of the Developer Publications Team’s style guidelines concerned with the Swift project on Swift.org as an official reference for contributors.

Tasks can be used to track internal work, extract individual subtasks
from a larger issue, and can serve as umbrella issues themselves.
External links added:
* Share an idea
  (https://forums.swift.org/c/evolution/discuss)
* Formally propose a change
  (https://www.swift.org/swift-evolution)
* Ask a question about Swift
  (https://forums.swift.org/c/swift-users)
* Ask a question about the Swift compiler
  (https://forums.swift.org/c/development/compiler)
* Ask a question on the Apple Developer Forums
  (https://developer.apple.com/forums)
* Learn Swift
  (https://docs.swift.org/swift-book/documentation/the-swift-programming-language)
* Report an issue with The Swift Programming Language book
  (https://github.com/apple/swift-book/issues/new/choose)
* Report an issue using Feedback Assistant
  (https://developer.apple.com/bug-reporting)
@AnthonyLatsis
Copy link
Collaborator Author

@swift-ci please smoke test

@AnthonyLatsis AnthonyLatsis merged commit df30c12 into swiftlang:main Nov 27, 2023
@AnthonyLatsis AnthonyLatsis deleted the migrate-to-issue-forms branch November 27, 2023 16:57
@amartini51
Copy link
Member

Also, the logic appears to suggest that "Swift Code of Conduct" is incorrectly capitalized.

That specific example is a bit of a gray area, so I would have to an editor for help to be completely sure. That said, "Swift Code of Conduct" is the title of a specific document, so you can write it in title case when referring to that document by name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants