Giter Club home page Giter Club logo

badges's Introduction

WILDS Badges

WILDS will and does have publicly available code in varying states of usability, development, and support. We think it's important to get code in users hands early and often to make sure we're solving users needs; given that situation, we want to clearly communicate that the software may not be stable yet. On the other extreme software may no longer be maintained, and we want to have a standard way to communicate about that as well.

Software maintainers often achieve this communication about the status of a piece of software using a simple badge at the top of the landing page for the software.

For the majority of documentation about WILDS badges see https://getwilds.org/badges/

References

These badges and content of this repository were adapted from the following sources:

badges's People

Contributors

sckott avatar

badges's Issues

Custom DaSL badges

@seankross Do we want any custom badges? If we do not, then we may not need this repo and can just use the badges and point to repostatus. But if we do want some custom badges, what custom badges do we want?

  • open to feedback before shipping
  • what else?

Even if we don't want custom badges we could still have this repo to document any further guidance we want to give our community around our use of badges

Do we want to have badges below the package level?

@seankross

So we did talk about possibly having an R package to do badge things. however, the only justifiable reason I can think to do that is if we want to use statuses on functions/classes/etc. below the package level, then an R package like https://github.com/r-lib/lifecycle/ really makes sense. I imagine we revisit this later if we thinks its needed? We could decide whenever that we should have function/class level statuses, but my gut feeling is we're not at that point yet

Thoughts?

Use badges niceties

It would be great to have a copy to clipboard button for badge text. We can poke around for javascriopt to use to do it, or possibly even use quarto which i know has that built in already

Point people to this repo or a rendered gh-pages site?

@seankross Should we point people to the readme of this repo? Or to a rendered gh-pages page?

That is, folllowing the repostatus or lifecycle pattern, clicking on one of our badges would bring the user to some site, which could be whatever. I'm guessing we should have people land on a gh-pages page?

Badges

  • Right now I only have the active badge copied from repostatus, but can copy over more
  • What text do we want to have on the left side? Right now it says repo status. Do we want to change that to something else?
  • Colors of the badges. They seem okay to me, but we can change them

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.