dotnet-foundation / projects

This repository is used for onboarding new projects
113 stars 31 forks source link

Standardized badge for .NET Foundation projects #110

Open terrajobst opened 3 years ago

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Friday, November 17, 2017 2:43:48 AM

It would be nice if we could recommend projects that join the foundation to advertise to the world that they are members of the .NET Foundation. Of course, the banner would be optional but having a standard template would help making it easier for projects to just add it if the would like to. I suspect most wouldn't have any concerns, it's just that it's work and fighting images and Markdown isn't exactly what engineers love doing.

I like how it looks on xUnit and propose the following look & feel:

1

Clicking on the logo would take you here:

2 3

The markup will look like this:

# About My Project

[<img align="right" width="80px" alt=".NET Foundation Logo" src="https://dotnetfoundation.org/images/logo_big.svg" />](https://dotnetfoundation.org/projects?type=project&q=MyProject)

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Thoughts?

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @ghuntley on Friday, November 17, 2017 2:56:18 AM

Hmm. Immediate thoughts are what message should be conveyed in the Lorem ipsum? aka What are the features and benefits that need to be advertised? This makes or breaks the value of having the banner.

The following themes imho should be included in a standardized banner:

Cool snippets (tm)

https://reactiveui.net/contribute/

If you’re being harassed, noticed someone else being harassed, or have any other concerns, please contact us immediately. Your reports will be taken seriously and will not be dismissed or argued with. All members, committers and volunteers in this community are required to act according to the Code of Conduct.

https://github.com/microsoft/workbooks

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com. When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

https://medium.com/open-collective/funding-open-source-how-webpack-reached-400k-year-dfb6d8384e19

Whether it’s the CEO of Stripe, who secretly is on there giving $10, to Capital One, who was our first ever sponsor. Even AG Grid, another open source project, is there. I started talking with them at a conference in Copenhagen and said “Hey, you’re trying to build your enterprise and we have lots of hits on our documentation. Instead of spending $20,000 to sponsor one conference, you could spend the same for millions of impressions by being on our docs page.” They tell me they get 50–100 clickthroughs daily. It’s easy marketing, more impactful than conference sponsorships.

https://www.fordfoundation.org/library/reports-and-studies/roads-and-bridges-the-unseen-labor-behind-our-digital-infrastructure/

Our modern society runs on software. But the tools we use to build software are buckling under increased demand. Nearly all software today relies on free, public code, written and maintained by communities of developers and other talent. This code can be used by anyone—from companies to individuals—to write their own software. Shared, public code makes up the digital infrastructure of our society today. Everybody relies on shared code to write software, including Fortune 500 companies, government, major software companies and startups. In a world driven by technology, we are putting increased demand on those who maintain our digital infrastructure. Yet because these communities are not highly visible, the rest of the world has been slow to notice. Just like physical infrastructure, digital infrastructure needs regular upkeep and maintenance. But financial support for digital infrastructure is much harder to come by. In the face of unprecedented demand, the costs of not supporting our digital infrastructure are numerous. No individual company or organization is incentivized to address the public good problem alone. In order to support our digital infrastructure, we must find ways to work together. Sustaining our digital infrastructure is a new topic for many, and the challenges are not well understood. In this report, Nadia Eghbal unpacks the unique challenges facing digital infrastructure, and how we might work together to address them.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Friday, November 17, 2017 5:08:11 AM

I should have been clearer: The banner is for the project's README.md. The lorem ipsum is the summary that the project already has in their README file.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @bradwilson on Friday, November 17, 2017 7:22:57 AM

Happy to be a trend-setter. 😉

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @martinwoodward on Friday, November 17, 2017 9:03:22 AM

Like the idea - do you want to submit a PR to this:

https://github.com/dotnet/home/blob/master/guidance/readme-guide.md

Also - the image should probably have an alt=".Net Foundation Logo" or similar.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Friday, November 17, 2017 2:48:24 PM

Also - the image should probably have an alt=".Net Foundation Logo" or similar.

You mean alt=".NET Foundation Logo" right? 🤓😬

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @jongalloway on Tuesday, November 21, 2017 10:16:48 PM

I think the idea is great. In the mockup that just shows the logo, though, it's not clear that it's a badge that links anywhere. Was thinking of something more GitHub badge-like (examples at https://shields.io/). That's harder to fit the logo in, but fits in better with badges in general.

Examples:

Gratipay build status last deployed chat on Discord follow on Twitter

Some ideas below (would be much smaller), source here.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Tuesday, November 21, 2017 10:58:30 PM

I was thinking of shields.io before but I couldn't find out how we can apply some visual branding. Looks like you figured it out. Personally, I think that is a great idea!

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @bdukes on Tuesday, November 21, 2017 11:13:20 PM

Shields.io has hackable URLs, so you can mock things up fairly easily:

net-foundation-68217a

net-foundation-bot

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Tuesday, November 21, 2017 11:34:30 PM

I vote for the second one as the first one is unregconizable.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @jongalloway on Tuesday, November 21, 2017 11:55:35 PM

@bdukes I like those and using shields.io is nice, but the logos are pretty hard to see. Here's one with the white version of the logo, any better?

net-foundationwhite-logo

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Wednesday, November 22, 2017 1:28:27 AM

I think the bot might be easier to see. Your example is bigger than what shields.io produces, once you scale it down it's similarly unreadable as the first logo @bdukes posted.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @loic-sharma on Wednesday, November 22, 2017 2:58:33 PM

The bot is still pretty hard to see. I'd rather have the badge with no logo as it's cleaner:

.NET Foundation Logo

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @jnm2 on Wednesday, November 22, 2017 4:45:17 PM

Yeah, I was leaning towards what @loic-sharma says myself.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Wednesday, November 22, 2017 5:28:01 PM

That works too. The key thing for me is that the link should be specific to the project, i.e. it shouldn't take the person to the generic .NET Foundation project list but an official page under dotnetfoundation.org that is specific to the project. This can be a dedicated page, a simple anchor, or (as I showed earlier) just a search. But it should be tailored.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @poke on Wednesday, November 22, 2017 5:38:55 PM

Just wondering: If we use such shield badges, are we required to keep it at their usual size? After all, this badge is to mark that a project is part of the foundation, so it would make sense for the badge not to just blend in with all the other ones. I actually like the size @jongalloway was using although maybe something at different dimensions might look even better (if it’s a bit less wide).

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @stevedesmond-ca on Thursday, November 23, 2017 3:20:03 AM

Do .NET and Foundation need to be different colors? This use as a static image/logo doesn't really follow the live status-based pattern that the other badges have. I like single color with our good friend the bot best.

terrajobst commented 3 years ago

Issue moved from dotnet/designs#23


From @terrajobst on Saturday, April 6, 2019 6:20:18 AM

@jongalloway can we revive this? Should we move the issue to https://github.com/dotnet/foundation?

Nirmal4G commented 3 years ago

@terrajobst You could've used GitHub's move issue feature to move the issue ditectly rather than copying using a third-party tool. That could've preserved the links using redirection.

bruno-garcia commented 3 years ago

@Nirmal4G not across github orgs

Nirmal4G commented 3 years ago

@github Note this request. Issue moves across repos in different orgs!!