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

Add nuget package badge and link #384

Closed

Conversation

WeihanLi
Copy link
Contributor

@WeihanLi WeihanLi commented Aug 17, 2022

**Closes #148 **

Preview here: https://github.com/WeihanLi/dotnet-CommunityTookit/blob/nuget-package-enhancement/README.md

image

Add the NuGet package badge and link to the NuGet package, hope it would help developers find the NuGet packages more easily

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

@Nirmal4G
Copy link
Contributor

A table format should be a better choice instead of in-lining the badges. They also look mis-aligned!

@WeihanLi
Copy link
Contributor Author

Would it looks better likes follows, maybe need a new block for the table:

Package Latest stable Latest Preview
CommunityToolkit.Mvvm CommunityToolkit.Mvvm CommunityToolkit.Mvvm
CommunityToolkit.Diagnostics CommunityToolkit.Diagnostics CommunityToolkit.Diagnostics
CommunityToolkit.HighPerformance CommunityToolkit.HighPerformance CommunityToolkit.HighPerformance
CommunityToolkit.Common CommunityToolkit.Common CommunityToolkit.Common

@Nirmal4G
Copy link
Contributor

Nirmal4G commented Aug 18, 2022

This looks nice but add the help links to the package name column and add a description column at the end. Like this.

Package Latest Stable Latest Preview Description
CommunityToolkit.Common CommunityToolkit.Common CommunityToolkit.Common This library has a set of helper APIs, shared with other CommunityToolkit libraries.

@WeihanLi
Copy link
Contributor Author

@Nirmal4G updated with table, looks better, thanks

README.md Outdated Show resolved Hide resolved
Co-authored-by: Nirmal Guru <Nirmal4G@gmail.com>
@hawkerm
Copy link

hawkerm commented Aug 27, 2022

Thoughts on updating the upper-right package link to?

image

I think it's pointing to 7.1.2 as it's pointing to Microsoft.Toolkit as the profile for the owner on NuGet and getting confused with the package for the same name?

@Nirmal4G
Copy link
Contributor

If we do that, then we should display both Microsoft.Toolkit.* and CommunityToolkit.* packages until we migrate away from the former packages.

@Sergio0694 and @michael-hawker Thoughts?

@Sergio0694
Copy link
Member

"until we migrate away from the former packages"

Not sure what you mean, we've already migrated away. I literally deprecated the Microsoft.Toolkit.* packages on NuGet 🙂

@Nirmal4G
Copy link
Contributor

I should have mentioned that "we" is "Community"! Sorry about that. But if it's not needed to display older packages, then we can remove it! Just wanted to be sure!! 😇

@Nirmal4G
Copy link
Contributor

Nirmal4G commented Sep 15, 2022

PR #439 should merge first. It might break this. So, don't forget to use the updated URLs and rebase on top of that merge.

@MisinformedDNA
Copy link

So we need the source generator package listed given it's not a package?

@Sergio0694
Copy link
Member

No, it should not be listed, it was my mistake adding that initially. It's just not a package, it should not be there 🙂

Sergio0694 and others added 26 commits September 17, 2022 03:22
@WeihanLi
Copy link
Contributor Author

Close it for a clean commit PR

@WeihanLi WeihanLi closed this Sep 17, 2022
@Nirmal4G
Copy link
Contributor

You could've just force-pushed!? Anyways it's fine.

@WeihanLi WeihanLi deleted the nuget-package-enhancement branch December 27, 2023 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add links to preview release NuGet packages
8 participants