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

[BUG] Improve readme content for readability #761

Closed
abergquist opened this issue Nov 27, 2023 · 4 comments
Closed

[BUG] Improve readme content for readability #761

abergquist opened this issue Nov 27, 2023 · 4 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation fixed-pending-release
Milestone

Comments

@abergquist
Copy link

Describe the Issue

I recommend the following at https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit:

  1. Since "Roslyn powered" is a compound modifier (cf. https://en.wikipedia.org/wiki/Compound_modifier), I recommend replacing it with "Roslyn-powered" in the following bullet points:
  • Roslyn powered language service for best in-class C# language features such as code navigation, refactoring, semantic awareness, and more

  • Roslyn powered semantic awareness

  1. With respect to the following bullet point:
  • AI-Assisted development

and the following sentence:

You can also uninstall it at the expense of some features if you're using a different AI-Assisted development extension.

it's good that you're already hyphenating "AI" and "Assisted"; I recommend, though, replacing "Assisted" with "assisted". That will make them consistent with the casing in the following sentence that appears later:

Auto-installing as part of C# Dev Kit, the IntelliCode for C# Dev Kit extension enhances the AI-assisted support beyond the basic IntelliSense code-completion found in the existing C# extension.

  1. I recommend inserting a comma immediately after "Kit" in the following sentence:

With C# Dev Kit your tests in XUnit, NUnit, MSTest and bUnit will be discovered and organized for you more easily for fast execution and results navigation.

Steps To Reproduce

No response

Expected Behavior

No response

Environment Information

No response

@abergquist abergquist added the bug Something isn't working label Nov 27, 2023
@microsoft-issue-labeler microsoft-issue-labeler bot added the area-project Project load, Solution Explorer label Nov 27, 2023
@tmeschter tmeschter added area-roslyn and removed area-project Project load, Solution Explorer labels Nov 27, 2023
@timheuer timheuer changed the title [BUG] https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit [BUG] Improve readme content for readability Nov 27, 2023
@webreidi webreidi added documentation Improvements or additions to documentation and removed area-roslyn labels Nov 28, 2023
@webreidi webreidi self-assigned this Nov 28, 2023
@webreidi webreidi added this to the Dec2023 milestone Nov 28, 2023
@webreidi webreidi modified the milestones: Dec2023, Jan2024 Jan 11, 2024
@gsweats
Copy link

gsweats commented Feb 9, 2024

@webreidi is there code with an updated README.md in it that's ready to merge or has been merged?

If there is nothing yet, I'd be happy to take a stab at it. Anything I can do to get involved because your GitHub workflow looks amazing, at least in the ~5 minutes I spent looking at 😉

You can see an example of how I wrote a long README for my first open-source published repo. It went nowhere and I didn't win, so I just leave it there in case someone weirdly wants it.
I have not read this for a year or two, commit history should be accurate.

🦖 The trxn8r (Transactionator) project, also known as t8r, went a bit on the artistic side of things, the avant garde as I've been told. Don't worry, I know how to tone things down and the Issue Description is plenty to start with (great work OP!).

You know, it's amazing, I accidentally stumbled here looking for a completely different extension. I am SO VERY HAPPY to have found an open-source project with such AMAZING, yet SIMPLE, monthly Iteration Plans. 👏👏👏 Look forward to a future here. Apologies in advanced while I get used to the workflow, and GitHub, as I use GitLab during the day.

🙏 Thank you!

Warning...I am notoriously awful at checking notifications and remembering to follow-up, but I will keep a note to check here.

@abergquist
Copy link
Author

abergquist commented Feb 10, 2024

Hi, I see that the "grammatical opportunities" I reported have been fixed at https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit. Thanks!

I noticed, though, that when I go to Extensions from VS Code and check out C# Dev Kit there, that they are still extant issues. Does the fixed (release pending) label above mean that they will be released there at some point as well?

@webreidi
Copy link

@abergquist Yes, this was fixed in the latest pre-release version of C# Dev Kit and will make it into our next stable version soon.

@abergquist
Copy link
Author

Thanks, @webreidi !

@webreidi webreidi modified the milestones: Jan2024, Feb2024 Feb 20, 2024
@webreidi webreidi closed this as completed Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation fixed-pending-release
Projects
None yet
Development

No branches or pull requests

4 participants