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

New NumFOCUS badge mockup #2256

Merged
merged 6 commits into from
Mar 10, 2020
Merged

New NumFOCUS badge mockup #2256

merged 6 commits into from
Mar 10, 2020

Conversation

sriramsk1999
Copy link
Contributor

@sriramsk1999 sriramsk1999 commented Mar 4, 2020

So after an IRC discussion, I've added the NumFOCUS badge to the mlpack page along with the code coverage and build status badges.

Obviously, I'm biased in thinking that this looks good so let me know what all of you think :)

README.md Outdated
@@ -17,6 +17,7 @@ src="https://cdn.rawgit.com/mlpack/mlpack.org/e7d36ed8/mlpack-black.svg" style="
<a href="http://ci.mlpack.org/job/mlpack%20-%20git%20commit%20test/"><img src="https://img.shields.io/jenkins/build.svg?jobUrl=http%3A%2F%2Fci.mlpack.org%2Fjob%2Fmlpack%2520-%2520git%2520commit%2520test%2F&label=Linux%20build&style=flat-square" alt="Jenkins"></a>
<a href="https://coveralls.io/github/mlpack/mlpack?branch=master"><img src="https://img.shields.io/coveralls/mlpack/mlpack/master.svg?style=flat-square" alt="Coveralls"></a>
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square" alt="License"></a>
<a href="http://numfocus.org"><img src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A" alt="NumFOCUS"></a>
Copy link
Member

Choose a reason for hiding this comment

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

Not sure powered by is a good wording here, also, this doesn't use the flat design as used by the other badges.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you suggest instead? Sponsored by?

Copy link
Member

Choose a reason for hiding this comment

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

If we want to follow the wording at the bottom of https://numfocus.org/project/mlpack then I guess we'd go with "Fiscally Supported Project". That seems pretty clunky though. Maybe "Sponsored Project" to match the menus? Can we write "Affiliated" without being wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree "Fiscally Supported Project" is a bit wordy. I'd prefer something short and sweet for the badge.

Powered by NumFOCUS
Sponsored by NumFOCUS
Affliated to NumFOCUS (not sure if it is right or not)

These would be my picks.

Copy link
Member

Choose a reason for hiding this comment

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

I'd vote for Sponsored by 👍

Copy link
Member

Choose a reason for hiding this comment

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

I don't really have a preference, I wonder if we really want to add that badge, I think it somewhat sticks out. However, if the mass likes the look fine with me as well.

README.md Outdated Show resolved Hide resolved
@sriramsk1999
Copy link
Contributor Author

I've made the requested changes. Only thing left to decide is if the badge is worth adding :) Oh and if the image banner after the second paragraph should be kept.

Copy link
Member

@birm birm left a comment

Choose a reason for hiding this comment

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

This may sound silly, but if we are going to have a badge and the numfocus link, wouldn't it make more sense to switch what they link to? The numfocus logo to the numfocus site, and the badge to the mlpack donation page?

@sriramsk1999
Copy link
Contributor Author

You're right, the badge should definitely link to mlpack's donation page. As for the logo, I also think it should point to NumFOCUS's main page (if we are keeping it that is.)

@rcurtin
Copy link
Member

rcurtin commented Mar 9, 2020

Personally, my thought is that if we have the button like you've added here, we can remove the bits from the README that we are a fiscally sponsored project. Those details can be pointed out on the website (see mlpack/mlpack.org#13 and mlpack/mlpack.org#15).

Overall my take is that it would be an improvement, so I'd like to see it merged, but my opinion isn't too strong here.

@zoq
Copy link
Member

zoq commented Mar 9, 2020

Personally, my thought is that if we have the button like you've added here, we can remove the bits from the README that we are a fiscally sponsored project. Those details can be pointed out on the website (see mlpack/mlpack.org#13 and mlpack/mlpack.org#15).

If I remember right, they ask us to use https://github.com/numfocus/templates in the onbording, not sure why Shōgun removed that part from there Readme.

@sriramsk1999
Copy link
Contributor Author

@rcurtin : I don't think it's possible to have a strong opinion on this trivial a change :)
I've gone ahead and made the changes you've mentioned.

PS ; Grip is great for testing markdown.

@sriramsk1999
Copy link
Contributor Author

@zoq : Ah didn't notice your comment :) I'll go ahead and revert it.

@sriramsk1999
Copy link
Contributor Author

Right, reverted the changes and added the fiscal sponsor attribution mentioned in that link. Appears to have been missed the first time. Or perhaps there's some reason I'm unaware of.

Copy link
Member

@zoq zoq left a comment

Choose a reason for hiding this comment

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

Looks fine for me.

@sriramsk1999
Copy link
Contributor Author

This may sound silly, but if we are going to have a badge and the numfocus link, wouldn't it make more sense to switch what they link to? The numfocus logo to the numfocus site, and the badge to the mlpack donation page?

I'd forgotten to change where the logo points to, just made that change. Hope that's okay.

Copy link
Member

@birm birm left a comment

Choose a reason for hiding this comment

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

Looks good; I'm ok with either link on the numfocus logo. @rcurtin any other thoughts?

@toshal-a toshal-a merged commit b18dc8b into mlpack:master Mar 10, 2020
@rcurtin
Copy link
Member

rcurtin commented Mar 10, 2020

Works for me too. I forgot that we had to keep the NumFOCUS blurb because that's specifically what they asked for; thanks @zoq for pointing that out. 👍

@sriramsk1999 sriramsk1999 deleted the powerfocus branch March 11, 2020 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants