Skip to content

Updated README.md Added Precise Swift Description #39536

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

Closed
wants to merge 3 commits into from
Closed

Updated README.md Added Precise Swift Description #39536

wants to merge 3 commits into from

Conversation

calijoefornium
Copy link

Added Precise Swift Description

Added Precise Swift Description
Swift makes it easy to write software that is incredibly fast and safe by design
Swift is a powerful and intuitive programming language for iOS, iPadOS, macOS, tvOS, and watchOS.
Writing Swift code is interactive and fun, the syntax is concise yet expressive, and Swift includes modern features developers love.
Swift code is safe by design, yet also produces software that runs lightning-fast.
Copy link
Member

Choose a reason for hiding this comment

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

This reads like an ad, is it really needed?

Copy link
Author

Choose a reason for hiding this comment

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

Hey @buttaface Thanks for reviewing I would like keep my point for your Query Asked

No it dosen't its just like providing some feature of Swift that is needed incase to understand advantages of swift over other Languages

@finagolfin
Copy link
Member

Unless you have permission from the Swift project, you will not be able to test or merge.

@varungandhi-apple, perhaps you'd like to chime in.

@finagolfin
Copy link
Member

You need someone with commit access to review, approve, and merge for you: take a look at the doc for how it works.

@calijoefornium
Copy link
Author

calijoefornium commented Oct 1, 2021

You need someone with commit access to review, approve, and merge for you: take a look at the doc for how it works.

Can you mention or know someone who has commit access to review, approve, and merge access so it would help me as well

@finagolfin
Copy link
Member

@benrimmington, you're one of the last people to modify this file, what do you think?

@calijoefornium
Copy link
Author

@benrimmington, you're one of the last people to modify this file, what do you think?

@benrimmington can you help me out if possible

@calijoefornium
Copy link
Author

@benrimmington, you're one of the last people to modify this file, what do you think?

@buttaface I think @benrimmington isn’t available or maybe inactive so @buttaface can you approve my pull request if possible

@calijoefornium calijoefornium changed the title Update README.md Updated README.md Oct 2, 2021
Copy link

@ejcheng ejcheng left a comment

Choose a reason for hiding this comment

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

This reads like an ad, is it really needed?

@buttaface I would say you are right, the README seems to be a cozy way to welcome new users of Swift, and it is not supposed to be the beginning of a tutorial. The additions in this PR don't really fit well with the existing tone of the document.

@calijoefornium
Copy link
Author

This reads like an ad, is it really needed?

@buttaface I would say you are right, the README seems to be a cozy way to welcome new users of Swift, and it is not supposed to be the beginning of a tutorial.

@import-brain thanks for reviewing I can change that but is my rest of content relatable??

@ejcheng
Copy link

ejcheng commented Oct 2, 2021

This reads like an ad, is it really needed?

@buttaface I would say you are right, the README seems to be a cozy way to welcome new users of Swift, and it is not supposed to be the beginning of a tutorial.

@import-brain thanks for reviewing I can change that but is my rest of content relatable??

The content is great, I just personally don't believe that README would be the right place for it. Perhaps there's a tutorial doc somewhere in the repo? I can look further...

@calijoefornium
Copy link
Author

@buttaface I would say you are right, the README seems to be a cozy way to welcome new users of Swift, and it is not supposed to be the beginning of a tutorial. The additions in this PR don't really fit well with the existing tone of the document.

@import-brain I have changed the heading if my rest of contents are good enough then can you approve my PR if possible ??

@ejcheng
Copy link

ejcheng commented Oct 2, 2021

@buttaface I would say you are right, the README seems to be a cozy way to welcome new users of Swift, and it is not supposed to be the beginning of a tutorial. The additions in this PR don't really fit well with the existing tone of the document.

@import-brain I have changed the heading if my rest of contents are good enough then can you approve my PR if possible ??

@yashhchitroda approved, I'm not a maintainer, so I can't merge

@calijoefornium
Copy link
Author

@import-brain Thanks for approving Can you guide me how can I merge my PR if possible

@ejcheng
Copy link

ejcheng commented Oct 2, 2021

@import-brain Thanks for approving Can you guide me how can I merge my PR if possible

Sure! We do not have permissions to merge PRs in this repository, but we can ask other people who have permissions to do it, e.g. tbkka (not @'ing them because they get notifications every time they are mentioned). I'm not sure who the write access people are besides tbkka, but if you find out, you could mention (@) them here.

If one of the people who has merge access decides your PR is good, then they will merge it for you.

@calijoefornium calijoefornium changed the title Updated README.md Updated README.md Added Precise Swift Description Oct 2, 2021
@calijoefornium
Copy link
Author

@finagolfin
Copy link
Member

@yashhchitroda, mentioning a bunch of unrelated names like that is not going to work and is more likely to get you added to their ignore lists.

What I did was check the commit history for this file, and then saw which of the recent authors showed recent activity on their github profile before pinging one person, Ben. He didn't respond, but it is now the weekend and this project is fairly quiet on weekends.

Also, marketing fluff like this in the doc is not a high priority, so obviously committers will put off reviewing pulls like this while they work on actual bug fixes or features. You might be waiting for weeks or months, and continually pinging people in the meantime is not going to endear you to them, ie you will make it take longer.

@calijoefornium
Copy link
Author

@yashhchitroda, mentioning a bunch of unrelated names like that is not going to work and is more likely to get you added to their ignore lists.

What I did was check the commit history for this file, and then saw which of the recent authors showed recent activity on their github profile before pinging one person, Ben. He didn't respond, but it is now the weekend and this project is fairly quiet on weekends.

Also, marketing fluff like this in the doc is not a high priority, so obviously committers will put off reviewing pulls like this while they work on actual bug fixes or features. You might be waiting for weeks or months, and continually pinging people in the meantime is not going to endear you to them, ie you will make it take longer.

@buttaface First of all Thanks for Reaching me I highly appreciate your dedication and loyalty towards me as I am new to GitHub’s PR stuffs I wasn’t getting things merged so I was in an tense situation that might be due to some mistakes my comments won’t be sent to people who has Write access so I was continuously trying to keep them updated with respect to pull request but as you explain things now I am clear about the process

                                      -Thanks for reaching out

@@ -37,6 +37,12 @@ features like flow control, data structures, and functions, with high-level
constructs like objects, protocols, closures, and generics. Swift embraces
modules, eliminating the need for headers and the code duplication they entail.

Announced in 2014, the Swift programming language has quickly become one of the fastest growing languages in history.
Swift makes it easy to write software that is incredibly fast and safe by design
Swift is a powerful and intuitive programming language for iOS, iPadOS, macOS, tvOS, and watchOS.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this line makes the description less precise, and furthers this misconception that it's a Apple/Darwin-only language.

The rest of the additions are already covered on the front page of swift.org.

Copy link
Author

Choose a reason for hiding this comment

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

@WowbaggersLiquidLunch thanks for reaching as you mentioned your point I support your point

but I don't think so it's less precise form anypoint of view, regarding swift.org well if it's in README it won't affect them either

Copy link

Choose a reason for hiding this comment

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

I think this line makes the description less precise, and furthers this misconception that it's a Apple/Darwin-only language.

The rest of the additions are already covered on the front page of swift.org.

@WowbaggersLiquidLunch I concur with this, Swift can be used for a lot more than developing apps for Apple products.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree this isn't very good wording, is a great general purpose language and there is no need to highlight apple platforms at the exclusion of others like this.

@@ -25,7 +25,7 @@
|**[Windows 2019 (VS 2017)](https://github.com/apple/swift-community-hosted-continuous-integration/blob/main/nodes/x86_64_windows_2019.json)** | x86_64 | [![Build Status](https://ci-external.swift.org/job/oss-swift-windows-x86_64/lastCompletedBuild/badge/icon)](https://ci-external.swift.org/job/oss-swift-windows-x86_64)|
|**[Windows 2019 (VS 2019)](https://github.com/apple/swift-community-hosted-continuous-integration/blob/main/nodes/x86_64_windows_2019_VS2019.json)** | x86_64 | [![Build Status](https://ci-external.swift.org/job/oss-swift-windows-x86_64-vs2019/lastCompletedBuild/badge/icon)](https://ci-external.swift.org/job/oss-swift-windows-x86_64-vs2019)|

## Welcome to Swift
## Welcome To Swift
Copy link
Contributor

Choose a reason for hiding this comment

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

The current capitalisation is correct. Propositions (unless at the start of sentence) are not capitalised in English titles: https://en.wikipedia.org/wiki/Title_case

Copy link
Author

Choose a reason for hiding this comment

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

Heading are always capatalized in order to grab users attraction

@ktoso
Copy link
Contributor

ktoso commented Oct 4, 2021

Thanks for the effort but personally I don't feel this is really helping the readme much to be honest 🤔
It isn't clear how this would make it more compelling and welcoming to new and different users of the language.

@calijoefornium
Copy link
Author

Thanks for the effort but personally I don't feel this is really helping the readme much to be honest thinking It isn't clear how this would make it more compelling and welcoming to new and different users of the language.

@ktoso Thanks for reaching me I don't think so maybe it will be helpful to some extent but anyways choice is up to you if you feel you can merge else close PR !!

@calijoefornium calijoefornium requested a review from ktoso October 4, 2021 03:45
@ktoso ktoso closed this Oct 4, 2021
@ktoso
Copy link
Contributor

ktoso commented Oct 4, 2021

Thanks again @yashhchitroda, but this specific PR we don't feel is improving the readme's feel, so I'll close the PR.

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

Successfully merging this pull request may close these issues.

5 participants