Skip to content

Update README to reflect Swift version 6.0.3 and testing library changes #821

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

meatball133
Copy link
Member

No description provided.

@meatball133 meatball133 added this to the Swift 6.0 milestone Jan 2, 2025
Copy link
Contributor

github-actions bot commented Jan 2, 2025

Hello 👋 Thanks for your PR.

This repo does not currently have dedicated maintainers. Our cross-track maintainers team will attempt to review and merge your PR, but it will likely take longer for your PR to be reviewed.

If you enjoy contributing to Exercism and have a track-record of doing so successfully, you might like to become an Exercism maintainer for this track.

Please feel free to ask any questions, or chat to us about anything to do with this PR or the reviewing process on the Exercism forum.

(cc @exercism/cross-track-maintainers)

@meatball133 meatball133 mentioned this pull request Mar 30, 2025
49 tasks
@meatball133 meatball133 marked this pull request as ready for review April 19, 2025 20:25
@@ -17,8 +17,12 @@ Hi.  👋🏽  👋  **We are happy you are here.**  🎉&nb
**`exercism/Swift`** is one of many programming language tracks on [exercism(dot)org][exercism-website].
This repo holds all the instructions, tests, code, & support files for Swift _exercises_ currently under development or implemented & available for students.

🌟 &nbsp;&nbsp;Track tooling (_test-runner and Continuous Integration_) runs on Swift `5.8.1`. <br>
Copy link
Member

Choose a reason for hiding this comment

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

Why are you inserting &nbsp in markdown?

Copy link
Member

Choose a reason for hiding this comment

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

The README appears to be an adaptation of the Python track readme. The &nbsp usage comes from there. https://github.com/exercism/python/blob/9b7a74b59eb82a65d926532f4590af3eb6861c30/README.md?plain=1#L39

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

README.md Outdated
@@ -65,7 +69,7 @@ Please keep in mind [Chesterton's Fence][chestertons-fence].

## Swift Software and Documentation

**Copyright © 2023 Apple Inc. All rights reserved.**
**Copyright © 2025 Apple Inc. All rights reserved.**
Copy link
Member

Choose a reason for hiding this comment

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

Why is the readme tagged with an Apply copyright?

Copy link
Member

Choose a reason for hiding this comment

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

The Swift logo is an Apple trademark so it should be cited as such. However, Apple's documentation says to mention "The Swift logo is a trademark of Apple Inc.", so we should include that. The original copyright notice probably was adapted from the PSF copyright notice in the Python track README.

Copy link
Member

@IsaacG IsaacG Apr 22, 2025

Choose a reason for hiding this comment

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

If the logo is trademarked by Apple, maybe we shouldn't be using it? Does this line indicate it is referring only to the logo and not the entire file and/or repo?

Copy link
Member Author

Choose a reason for hiding this comment

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

Legally speaking is the name Swift trademarked as well so not only the logo. Most languages haven't cared about this, if you check most languages on the website which uses the real logo. So does most of them require you to refer to say who owns the logo. However I have a very hard time to see any company doing a dmca takedown anyways.

Copy link
Member

Choose a reason for hiding this comment

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

+cc @iHiD for FYI/thoughts

Copy link
Member

Choose a reason for hiding this comment

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

I think we can get rid of this line. I'm happy with the line below.

🌟 &nbsp;&nbsp;Most exercises are solvable with Swift `6.0.0` or higher.

As of 2025 does the track use the new [swift-testing][swift-testing] library for testing. This makes the so you have to use Swift 6.0.0 or higher to run the tests.
If you wish to still run the tests with the old XCTest framework, you can do so by pulling the `5.x` branch.
Copy link
Member

Choose a reason for hiding this comment

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

Students can work locally with the old tests, but can they submit their code to the site? The track would run the Swift 6.0 tests so would that break tests on submission? Some more detail here could be useful.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not really. Most earlier solutions will still work. I think around 5-10% of the exercises have changed test cases, and those will not exist on the 5.x changes so those will likely not work.

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.

4 participants