Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.7 KB

README.md

File metadata and controls

52 lines (39 loc) · 2.7 KB
Raw

Donations - Community Audited Donation Proofs

Motivation

We want to increase the credibility of published donations. This can be done in many ways, some fancy others simpler. The only bulletproof way is to make charities publish Cardano addresses so that SPOs can show that they actually sent money to that specific charity. Unfortunately this is a solution that is a very long way of. To have a standardized information pool about donations and at least enable some degree of trust and auditability in that, we created this repository.

Methodology

You cannot merge on your own to this repository (even admins cannot), you need to submit a PR which will be reviewed by the CI and one member of the CardanoMDP github organization (see: Members List).

Steps

  1. Fork this repo
  2. In your fork:
    1. Create a folder named like your pool's Ticker
    2. Add your donation files image
    3. Create a donations.yml (see: example.donations.yml) If you are unfamiliar with Yaml check out this 5 minute tutorial
    4. Submit a pull request.
  3. Once a pull request is created the members of the CardanoMDP github organization will be notified
    1. If you want a specific member of that list to review your submission you can select a specific reviewer in the top left corener of the pull request view. image
  4. Make suree the CI tests pass. If the middle check in your PR is red there are errors in your donations.yml that you need to fix image Click on details to see what check went wrong (typically either a file reference is incorrect or a required field is missing).

Data Structure

This repository is meant to represent a dedicated space to each SPO. The intended folder structure is as follows

-| TICKER
    |- donations.json (required)
    |- donation-proof-2020-12.jpg <- You will be referencing these images. You are free to name them as you like.
    |- donation-proof-2021-01.jpg
    |- donation-proof-2021-02.jpg
    |- Some_Folder <- you can also organize your extra files in folders, just don't forget to add the folder names to the paths in donations.json
 | TICKER
 | TICKER
 | TICKER
 | TICKER
 | TICKER
 | TICKER

Examples

For a documented example see example.donations.yml.

For a realworld example see the SPEC folder.