Skip to content

Improve README.md - #1870

Merged
Gina Triolo (gitri-ms) merged 9 commits into
microsoft:mainfrom
MixeroTN:main
Jul 6, 2023
Merged

Improve README.md#1870
Gina Triolo (gitri-ms) merged 9 commits into
microsoft:mainfrom
MixeroTN:main

Conversation

@MixeroTN

Copy link
Copy Markdown
Contributor

Motivation and Context

README.md had several visual problems, which I decided to fix.

Description

  • The first problem was a dotnet-ci status badge, which is no longer available. I replaced it with two status badges: dotnet-ci-docker and dotnet-ci-windows.
  • The second one was Using Semantic Kernel in C# and Python. The icons were positioned out of place. I have made a small table with the icons and hyperlinks present earlier.
  • And finally, small corrections such as h3 lines for C# and Python approaches above getting started with the basics instructions.

Contribution Checklist

@github-actions github-actions Bot added the docs and tests Improvements or additions to documentation label Jul 6, 2023
@MixeroTN

Copy link
Copy Markdown
Contributor Author

Michał Gołkowski (@MixeroTN) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

@dmytrostruk Dmytro Struk (dmytrostruk) added the PR: ready for review All feedback addressed, ready for reviews label Jul 6, 2023
Comment thread README.md Outdated
Changed table width to 25%
Changed table width to 100%
@gitri-ms
Gina Triolo (gitri-ms) added this pull request to the merge queue Jul 6, 2023
Merged via the queue into microsoft:main with commit 69fb411 Jul 6, 2023
@gitri-ms

Copy link
Copy Markdown
Contributor

Thank you Michał Gołkowski (@MixeroTN)!

John (johnoliver) pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

`README.md` had several visual problems, which I decided to fix.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

- The first problem was a `dotnet-ci` status badge, which is no longer
available. I replaced it with two status badges: `dotnet-ci-docker` and
`dotnet-ci-windows`.
- The second one was *Using Semantic Kernel in C# and Python*. The icons
were positioned out of place. I have made a small table with the icons
and hyperlinks present earlier.
- And finally, small corrections such as h3 lines for C# and Python
approaches above *getting started with the basics* instructions.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
John (johnoliver) pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

`README.md` had several visual problems, which I decided to fix.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

- The first problem was a `dotnet-ci` status badge, which is no longer
available. I replaced it with two status badges: `dotnet-ci-docker` and
`dotnet-ci-windows`.
- The second one was *Using Semantic Kernel in C# and Python*. The icons
were positioned out of place. I have made a small table with the icons
and hyperlinks present earlier.
- And finally, small corrections such as h3 lines for C# and Python
approaches above *getting started with the basics* instructions.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs and tests Improvements or additions to documentation PR: ready for review All feedback addressed, ready for reviews

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants