DA0-DA0 / dao-contracts

CosmWasm smart contracts for Interchain DAOs.
https://docs.daodao.zone
BSD 3-Clause "New" or "Revised" License
202 stars 133 forks source link

shields.io docs.rs badges #740

Closed poroburu closed 10 months ago

poroburu commented 10 months ago

Added shields.io docs.rs badges for contracts #732

Following contracts are missing docs.rs pages:

cw-fund-distributor
cw-tokenfactory-issuer
cw721-roles
dao-voting-cw721-roles
dao-voting-token-factory-staked
JakeHartnell commented 10 months ago

AMAZING!!!!

Few more improments we can make (will also save us some pain in the future):

In the main README:

![Discord](https://img.shields.io/discord/895922260047720449?label=Discord) ![GitHub tag (with filter)](https://img.shields.io/github/v/tag/DA0-DA0/dao-contracts?label=Latest%20version) ![Codecov](https://img.shields.io/codecov/c/github/DA0-DA0/dao-contracts?label=Test%20coverage) ![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FDA0_DA0&style=social&label=Twitter)

Discord GitHub tag (with filter) Codecov X (formerly Twitter) URL

For individual packages (for example, dao-dao-core:

[![dao-dao-core on crates.io](https://img.shields.io/crates/v/dao-dao-core.svg)](https://crates.io/crates/dao-dao-core)  [![Docs](https://docs.rs/dao-dao-core/badge.svg)](https://docs.rs/dao-dao-core)

dao-dao-core on crates.io Docs

Perhaps there are some other badges we want as well? https://shields.io/badges

This is super helpful! Thank you! :pray:

poroburu commented 10 months ago

Main

Added icons and keeping the native codecov shield:

[![GitHub tag (with filter)](https://img.shields.io/github/v/tag/DA0-DA0/dao-contracts?label=Latest%20version&logo=github)](https://github.com/DA0-DA0/dao-contracts/releases/latest)
[![codecov](https://codecov.io/gh/DA0-DA0/dao-contracts/branch/main/graph/badge.svg?token=SCKOIPYZPV)](https://codecov.io/gh/DA0-DA0/dao-contracts)
[![Discord](https://img.shields.io/discord/895922260047720449?logo=discord&label=Discord)](https://discord.gg/MUBxdbwJDD)
[![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FDA0_DA0&label=DA0_DA0)](https://twitter.com/DA0_DA0)

GitHub tag (with filter) codecov Discord X (formerly Twitter) URL

Contracts

No crates.io logo in https://github.com/simple-icons/simple-icons/blob/master/slugs.md

[![dao-dao-core on crates.io](https://img.shields.io/crates/v/dao-dao-core.svg?logo=rust)](https://crates.io/crates/dao-dao-core)
[![docs.rs](https://img.shields.io/docsrs/dao-dao-core?logo=docsdotrs)](https://docs.rs/dao-dao-core/latest/dao_dao_core/index.html)

dao-dao-core on crates.io docs.rs

poroburu commented 10 months ago

Shield brainstorm

Commit history

GitHub commit activity (branch) For whatever reason does not like the repo structure. Seems to only be available on default or specific branch.

Contributors

GitHub contributors

Licence

GitHub

DAO DAO

Activity? TVL? If that statistic is easily retrieved, could make a custom badge.

JakeHartnell commented 10 months ago

@poroburu contributors and commits are great adds!

License no, because our contracts vary in license. Some are forks and inherit Apache 2.0.

Oh, we should make a custom DAO badge and link to the DAO DAO DAO! https://daodao.zone/dao/juno10h0hc64jv006rr8qy0zhlu4jsxct8qwa0vtaleayh0ujz0zynf2s2r7v8q/proposals

poroburu commented 10 months ago

The groupings are a bit too vertical, but it satisfies my OCD the most. LGTM.


GitHub tag (with filter) GitHub contributors

GitHub commit activity (branch) codecov

Discord X (formerly Twitter) URL

DAO DAO DAO


Custom logos for shields can be used as base64: https://github.com/DA0-DA0/docs/blob/main/static/img/daodao.png https://www.base64-image.de/

JakeHartnell commented 10 months ago

AMAZING! :clap: