Skip to content

readme enhancement for nuget package#444

Merged
Sergio0694 merged 2 commits intoCommunityToolkit:mainfrom
WeihanLi:readme-nuget-package-enhancement
Sep 17, 2022
Merged

readme enhancement for nuget package#444
Sergio0694 merged 2 commits intoCommunityToolkit:mainfrom
WeihanLi:readme-nuget-package-enhancement

Conversation

@WeihanLi
Copy link
Copy Markdown
Contributor

@WeihanLi WeihanLi commented Sep 17, 2022 •
edited
Loading

**Closes #148 **

PR Checklist

  • Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
  • Based off latest main branch of toolkit
  • PR doesn't include merge commits (always rebase on top of our main, if needed)
  • Tested code with current supported SDKs
  • New component
    • Pull Request has been submitted to the documentation repository instructions. Link:
    • Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
  • Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Header has been added to all new source files (run build/UpdateHeaders.bat)
  • Contains NO breaking changes
  • Every new API (including internal ones) has full XML docs
  • Code follows all style conventions

Other information

Add the NuGet package info and links, thanks for @Nirmal4G 's help

Preview: https://github.com/WeihanLi/dotnet-CommunityTookit/blob/readme-nuget-package-enhancement/README.md#-what-does-this-repo-contain

image

Nirmal4G
Nirmal4G suggested changes Sep 17, 2022
View reviewed changes
@Nirmal4G
Copy link
Copy Markdown
Contributor

Nirmal4G commented Sep 17, 2022

@Sergio0694 @michael-hawker Also, the docs.microsoft.com has been changed to learn.microsoft.com. Do we need to update it here or in a separate PR?

@WeihanLi @Nirmal4G
Update README.md
2c270b1 
Add link for `CommunityToolkit`

Co-authored-by: Nirmal Guru <Nirmal4G@ymail.com>
Nirmal4G
Nirmal4G approved these changes Sep 17, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@Nirmal4G Nirmal4G left a comment

Choose a reason for hiding this comment

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

🎊

Sergio0694
Sergio0694 approved these changes Sep 17, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@Sergio0694 Sergio0694 left a comment

Choose a reason for hiding this comment

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

Thank you! 🙂

@Sergio0694 Sergio0694 merged commit 1287507 into CommunityToolkit:main Sep 17, 2022
@WeihanLi WeihanLi deleted the readme-nuget-package-enhancement branch September 17, 2022 15:37
@Sergio0694
Copy link
Copy Markdown
Member

Sergio0694 commented Sep 17, 2022

@Nirmal4G The docs have redirects, so we can update them later on if we want. We're using docs everywhere anyway 😄

@Nirmal4G
Copy link
Copy Markdown
Contributor

Nirmal4G commented Sep 17, 2022

I was aware of that. I only discovered through this PR. Just notifying the project maintainers. That's all. 😇

@renovate renovate bot mentioned this pull request Nov 20, 2024
Open
1 task
@dependabot dependabot bot mentioned this pull request Dec 27, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Sergio0694 Sergio0694 Sergio0694 approved these changes

+1 more reviewer

@Nirmal4G Nirmal4G Nirmal4G approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add links to preview release NuGet packages

3 participants

@WeihanLi @Nirmal4G @Sergio0694