Skip to content

[Proposal] New Assembly/Package Title format #3897

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

Closed
Nirmal4G opened this issue Mar 27, 2021 · 7 comments · Fixed by #3894
Closed

[Proposal] New Assembly/Package Title format #3897

Nirmal4G opened this issue Mar 27, 2021 · 7 comments · Fixed by #3894

Comments

@Nirmal4G
Copy link
Contributor

Nirmal4G commented Mar 27, 2021

New Package Title

The package title doesn't follow a particular format and is not machine readable. Thus, I propose the following format.

Product - Area - Specifics (Source/Target)

Example:

Assembly/Package Name Assembly/Package Title
Microsoft.Toolkit Windows Community Toolkit - Common (.NET Standard)
Microsoft.Toolkit.Uwp Windows Community Toolkit - Common (UWP)
Microsoft.Toolkit.Uwp.Input Windows Community Toolkit - Input - Gaze Interaction (w. EyeTracker)
Microsoft.Toolkit.Uwp.UI Windows Community Toolkit - UI
Microsoft.Toolkit.Uwp.UI.Controls.Core Windows Community Toolkit - Common Controls
Microsoft.Toolkit.Uwp.UI.Controls.Markdown Windows Community Toolkit - Markdown Control

Note

The names and the format are not final. Please do suggest your ideas for the new titles.

@ghost ghost added the needs triage 🔍 label Mar 27, 2021
@ghost
Copy link

ghost commented Mar 27, 2021

Hello Nirmal4G, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

@ghost ghost added the In-PR 🚀 label Mar 27, 2021
@Nirmal4G Nirmal4G changed the title Update package titles and consolidate build logic Update package titles and refactor markdown files Mar 27, 2021
@ghost ghost removed the needs triage 🔍 label Mar 27, 2021
@Nirmal4G Nirmal4G changed the title Update package titles and refactor markdown files [Proposal] New Package title format Mar 27, 2021
@ghost ghost removed the In-PR 🚀 label Mar 27, 2021
@Nirmal4G Nirmal4G changed the title [Proposal] New Package title format [Proposal] New Assembly/Package title format Mar 27, 2021
@Nirmal4G Nirmal4G changed the title [Proposal] New Assembly/Package title format [Proposal] New Assembly/Package Title format Mar 27, 2021
@ghost ghost added the In-PR 🚀 label Mar 27, 2021
@Kyaa-dost
Copy link
Contributor

Thanks @Nirmal4G for the proposal. Opened this up for discussion to get insight from the rest of the community as well.

@michael-hawker
Copy link
Member

Thanks @Nirmal4G for this proposal, makes sense. I was just confused at first, as I thought you were suggesting changing package ids, but it's just making our existing titles a bit more consistent, which sounds great!

I'm just getting back into things, so let's noodle on the names a bit this week in case we have any suggestions. Thanks again!

@ghost ghost added In-PR 🚀 and removed In-PR 🚀 labels Jul 8, 2021
@Nirmal4G
Copy link
Contributor Author

@michael-hawker Review in PR

Thanks @azchohfi, yeah we couldn't use the term 'Basic' here. Let's just label it with the technology for now.

What's the reason? If it's too vague or generic, we can use Common/Core, etc.. But that's just introducing different words for the same meaning into what is seemingly a simple package title.

If we are worried about discoverability (Web/NuGet search), package tags will take care of it. Package titles should be simple yet descriptive but brief.

@michael-hawker
Copy link
Member

@Nirmal4G "Basic" isn't any more descriptive and also is more diminutive. It's also introducing another term we're not using to describe any of the packages anywhere else. We can think about if there's a better term for the future, but for now let's just keep it simple and work on merging the PR as there's already been a lot of discussion on things that have very minimal impact overall. Like the Title doesn't really show up anywhere in VS or Nuget.org.

@Nirmal4G
Copy link
Contributor Author

Some of the new titles you've proposed doesn't follow the format I mentioned above. If Basics doesn't cut it, How about using Common/Core?

…things that have very minimal impact overall. Like the Title doesn't really show up anywhere in VS or NuGet!

Then, does it matter when there's a (new) term to describe those packages?

If we can't decide right now, I could separate the title changes into a new PR.

@michael-hawker
Copy link
Member

That's what I updated them too. We can fiddle on this later if we need to, but think the updated formatting with the hyphen is fine. I've committed my suggestions, so all that's left on that PR is the open comment about reverting the targetframework for Uno. If you can do that bit, we can get that PR merged and move on to your other PRs.

@ghost ghost added Completed 🔥 and removed In-PR 🚀 labels Jul 20, 2021
@ghost ghost locked as resolved and limited conversation to collaborators Nov 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants