-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Improve README.md #1870
Merged
Merged
Improve README.md #1870
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
docs and tests
Improvements or additions to documentation
label
Jul 6, 2023
@microsoft-github-policy-service agree |
dmytrostruk
added
the
PR: ready for review
All feedback addressed, ready for reviews
label
Jul 6, 2023
gitri-ms
reviewed
Jul 6, 2023
Changed table width to 25%
Changed table width to 100%
gitri-ms
approved these changes
Jul 6, 2023
Thank you @MixeroTN! |
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 😄
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
README.md
had several visual problems, which I decided to fix.Description
dotnet-ci
status badge, which is no longer available. I replaced it with two status badges:dotnet-ci-docker
anddotnet-ci-windows
.Contribution Checklist
dotnet format