changed 5 months ago
Linked with GitHub

Steps to Extend and Publish an Extended DAOIP-5 Schema Specification

Step 1: Define the Extension Scope

Determine the component to extend within DAOIP-5:

  1. Identify which of the four main components (Grant Systems, Grant Pools, Projects, Applications) requires extension.
  2. Clearly specify the purpose and scope of the extension.
    • Example: Extend the Grant Pools component to include fields for financial transparency.

Step 2: Draft the Extension Specification

Use the following template to create a technical specification for the extended schema:

Example Template: https://hackmd.io/@torchablazed/H1XIAJDVyg

Template for the Extended Specification

### **Title**: DAOIP-5: [Entity Name] Grants Management - Extended Metadata Schema for [Component/s Name]
#### **Status**: [Draft | Final]
#### **Version**: [Version Number]
#### **Date**: [YYYY-MM-DD]
#### **Authors**: [Author Name(s) and Contact Information]
#### **Extended Specification Link**: [URL for Documentation]

---

### **Simple Summary**
[Briefly explain the purpose of the extension in plain language.]

---

### **Abstract**
[Summarize the need for the extension and the components it affects. Explain how it enhances DAOIP-5 capabilities.]

---

### **Motivation**
[Explain the specific problem or limitation addressed by the extension and why the additional fields or components are necessary.]

---

### **Specification**
#### **Components of DAOIP-5**
The DAOIP-5 specification is organized into four main components:
1. **Grant Systems**: Governance or administration entities for grants.
2. **Grant Pools**: Fundable objects (e.g., smart contracts or treasury accounts) used to distribute grants.
3. **Projects**: Persistent entities applying for grants.
4. **Applications**: Specific submissions by projects to grant pools.

#### **Component/s Extended**
[Specify which component/s is being extended.]

#### **New Fields**
[List and define the new fields added, including type, description, and examples for each of the components extended.]

**Example Field Definition for Grant Pool Extension Table**:
| **Field Name**      | **Type**             | **Description**                                    | **Required** |
|---------------------|---------------------|--------------------------------------------------|--------------|
| `grantPoolSize`     | Object           | Total amount of tokens alloted to the grant pool in amount and denomination   | Yes          |
| `grantPoolFunders`  | Array of Strings    | List of DAOs/entities funding the grant pool.    | Yes          |
| `grantPoolMechanism` | String | Name of the Grant Mechanism | Yes |
| `investmentSources`  | Object | Details of your investment sources | Yes |

---
### ** Grant Pool Schema Updates**
Provide the complete updated schema in JSON-LD format:

```json
{
  "@context": [
    "http://www.daostar.org/schemas",
    "http://yourorganization.org/schemas/daoip-5-extended"
  ],
  "type": "GrantPool",
  "id": "eip155:1:0x2345bcde",
  "name": "Innovation Grants",
  "description": "Grants supporting open-source projects.",
  "grantPoolMechanism": "Quadratic Funding",
  "grantPoolSize":  {
        "amount": "100000",
        "denomination": "OP"
                },
  "grantPoolFunders": {
    "optimism.io",
    "gitcoin.co",
  },
  "investmentSources": {
        "series": "A",
        "amount": "1000000",
        "denomination": "USD",
        "funders": "a16z"
                },
  ]
}

### **Integration**
#### **Backward Compatibility**
[Explain how the extension will maintain compatibility with existing DAOIP-5 implementations.]

#### **Validation**
[List steps to validate the extended schema, e.g., testing using JSON-LD validation tools.]

#### **Examples**
[Provide detailed examples of how the extended schema can be used in different contexts.]

### **Publishing Details**
#### **Publishing Organization**
- **Name**: [Your Organization Name]
- **Contact**: [Contact Email]
- **Website**: [Website URL]

#### **Extended Schema Publication**
- **Link**: [URL to the extended schema documentation]
- **Validation**: [Validation results and tools used]

### **Future Work** (Optional)
[Describe potential improvements or additional features for the extended schema.]

### **Acknowledgments**
[Thank contributors and collaborators.]

Step 3: Validate the Extended Schema

  1. Use JSON-LD tools like JSON-LD Playground to validate the schema structure.
  2. Test the schema with sample data for different use cases.

Step 4: Publish the Extended Specification

  1. Host the extended specification documentation on a public, version-controlled platform (e.g., GitHub, a dedicated organization website).
  2. Update the @context field to reference both the original and extended schema URLs in the published DAOIP-5 data

Step 5: Share and Collaborate

  1. Communicate the extension to relevant stakeholders and communities.
  2. Invite feedback for iterative improvements.
  3. Promote adoption by providing clear examples and integration guidance.

The above steps ensures the extension is well-documented, compliant, and accessible, enabling widespread adoption and usability within the DAOIP-5 framework.

Select a repo