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

Update Documentation: Add MacOS with Make instructions for Exercism CLI #930

Merged
merged 3 commits into from
Dec 29, 2024

Conversation

cbullard-dev
Copy link
Contributor

Update Documentation: Add MacOS with Make instructions for Exercism CLI

This PR updates the documentation to improve the "MacOS with Make when using the Exercism CLI" section. The updated instructions clarify the process of configuring, testing, and submitting C++ exercises with the Exercism CLI on MacOS.

Rationale:

This update aligns the section with existing style and cadence in the documentation while providing additional clarity for users who may be unfamiliar with the nuances of the Exercism CLI setup. It aims to minimize confusion and ensure a smooth setup process on MacOS.

Impact:

  • Enhances the clarity of instructions for MacOS users.
  • Provides explicit details to streamline the C++ exercise workflow with the Exercism CLI.

Testing:

  • Verified the commands and workflow on MacOS using Unix Makefiles with the Exercism CLI.
  • Ensured documentation style and tone are consistent with existing content.

when running on Mac OS as. This should allow for new lerners of C++ to
be able to get up and running using the CLI without needing an IDE like
XCode setup and configured and be able to use the exercism tools
available.
Copy link
Contributor

Hello. Thanks for opening a PR on Exercism 🙂

We ask that all changes to Exercism are discussed on our Community Forum before being opened on GitHub. To enforce this, we automatically close all PRs that are submitted. That doesn't mean your PR is rejected but that we want the initial discussion about it to happen on our forum where a wide range of key contributors across the Exercism ecosystem can weigh in.

You can use this link to copy this into a new topic on the forum. If we decide the PR is appropriate, we'll reopen it and continue with it, so please don't delete your local branch.

If you're interested in learning more about this auto-responder, please read this blog post.


Note: If this PR has been pre-approved, please link back to this PR on the forum thread and a maintainer or staff member will reopen it.

@github-actions github-actions bot closed this Dec 29, 2024
@IsaacG IsaacG reopened this Dec 29, 2024
@IsaacG
Copy link
Member

IsaacG commented Dec 29, 2024

Relevant forum thread: https://forum.exercism.org/t/14261/

docs/TESTS.md Outdated Show resolved Hide resolved
@neenjaw neenjaw added x:action/improve Improve existing functionality/content x:type/docs Work on Documentation x:size/small Small amount of work x:rep/small Small amount of reputation labels Dec 29, 2024
@neenjaw neenjaw merged commit 66c8cdc into exercism:main Dec 29, 2024
@vaeng
Copy link
Contributor

vaeng commented Dec 29, 2024

Thank you for taking the time to update Mac instructions. There is another help file, that would benefit a Mac treatment, or do you think it is sufficient?

https://github.com/exercism/cpp/blob/main/exercises/shared/.docs/tests.md

@cbullard-dev
Copy link
Contributor Author

I can take a look at it to see if I can run it based on that I can see if I can update the docs ✌🏼

@cbullard-dev
Copy link
Contributor Author

Thank you for taking the time to update Mac instructions. There is another help file, that would benefit a Mac treatment, or do you think it is sufficient?

https://github.com/exercism/cpp/blob/main/exercises/shared/.docs/tests.md

I have read over the documentation here and this looks pretty universal and I don't think it would need Mac OS specific instruction as this has more to do with the TDD style of testing and how to iterate over the tests.

Let me know if you disagree ✌🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/improve Improve existing functionality/content x:rep/small Small amount of reputation x:size/small Small amount of work x:type/docs Work on Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants