contributing section completed and list of participants added to CC minting process

c-georgen · c-georgen · commit c471b26a2429 · 2024-05-30T12:09:33.000-05:00
diff --git a/change-credits/cc-minting.md b/change-credits/cc-minting.md
@@ -0,0 +1,56 @@
+---
+label: Minting Change Credits
+layout: page
+order: -2
+---
+
+## Minting
+
+Because Change Credits are only minted following confirmation of realized, tangible, and verifiable impact, there the process by which these assets are created follows a number of steps and involves multiple types of actors.
+
+### Participants
+
+Good Generator
+:   A Good Generator is the implementing organization responsible for seeing the planned impact results achieved. It is through the actions of this entity, often an NGO or social enterprise, that positive externalities are produced. Because contributions and funds can be seamlessly fractionalized and divided, a Good Generator can also be a collection of multiple contributors working collaboratively.
+
+Change Code
+:   Change Code acts to provide all necessary infrastructure for the creation and management of Change Credits through its *Changescape*. While Change Code is not involved in the measurement or verification of any results produced, it is responsible for assessing the legitimacy and compliance of any organizations seeking to mint Change Credits.
+
+Partner
+:   Partners financially contribute to the positive externalities embodied in Change Credits. They fund the delivery of impact by pre-purchasing Change Credits in advance.
+
+Verifier
+:   Verifiers exist to both validate, measure, and quantify any impact produced. Verifiers are defined by the Good Generator of the project with a focus on local context and relevant expertise. Verification can be conducted by a single individual or organization or the responsibility can be dispersed through a set of Verifiers with a specified quorum required.
+
+### Minting Flow
+
+```mermaid
+sequenceDiagram
+    actor Verifier
+    actor Good Generator
+    create participant hypercert (ERC1155)
+    Good Generator->>hypercert (ERC1155): mint impact goal
+    actor Change Code
+    Change Code--xhypercert (ERC1155): review impact goal
+    create participant Token Bound Account (ERC6551)
+    Change Code->>Token Bound Account (ERC6551): deploy treasury account
+    actor partner
+    loop
+        partner->>Token Bound Account (ERC6551): send $
+        Token Bound Account (ERC6551)->>partner: mint IOUs (ERC20)
+        Token Bound Account (ERC6551)->>Good Generator: remit funding received
+    end
+    loop
+        Good Generator-->Good Generator: implement project
+        Good Generator->>hypercert (ERC1155): submit evidence
+        Verifier--xhypercert (ERC1155): review evidence
+        Change Code--xhypercert (ERC1155): assign token quantity
+        Change Code->>Token Bound Account (ERC6551): mint Change Credits (ERC721)
+    end
+    Loop
+        partner->>Token Bound Account (ERC6551): return IOUs
+        Token Bound Account (ERC6551)->>partner: receive Change Credits
+    end
+```
+
+The above sequence diagram overviews the process of 
diff --git a/change-credits/foundations.md b/change-credits/foundations.md
@@ -1,10 +1,16 @@
-# Background & Minting
+---
+label: Foundations
+layout: page
+order: -1
+---
+
+# Foundations
 
 Change Credits are a novel *financial* primitive supporting resource allocation, verification, and tracking of positive externalities (social and environmental impact).
 
 They are the basis and grounding of Change Code's economic engine, providing a real-world tangible link to underpin a new form of beneficial currency.
 
-## Foundation
+## Supporting Primitives and Infrastructure
 
 Before expanding on the architecture and processes involved in Change Credits directly, we should first recap (or introduce) some of the existing open-source tools and standards leveraged here.
 
@@ -32,37 +38,4 @@ Hypercerts adhere to the ERC1155 standard for semi-fungible tokens. This mixed s
 ERC20 tokens are fully fungible and well suited for liquidity and open exchange. IOUs issued in anticipation of Change Credits themselves are minted as ERC20 tokens to support the emergence of free exchange by holders who may wish to access liquidity.
 +++ ERC6551
 Referred to as "token bound accounts" (TBAs), ERC6551 tokens function as a form of smart contract wallet where an account is simultaneously able hold or mint tokens itself and be considered a token (an NFT more specifically) in its own right. Change Code leverages TBAs to serve as *treasury accounts* for the receipt of funds into projects and the minting of Change Credits.
-+++
-
-## Change Credit Minting
-
-Because Change Credits are only minted following confirmation of realized, tangible, and verifiable impact, there the process by which these assets are created follows a number of steps and involves multiple types of actors.
-
-```mermaid
-sequenceDiagram
-    actor Verifier
-    actor Good Generator
-    create participant hypercert (ERC1155)
-    Good Generator->>hypercert (ERC1155): mint impact goal
-    actor Change Code
-    Change Code--xhypercert (ERC1155): review impact goal
-    create participant Token Bound Account (ERC6551)
-    Change Code->>Token Bound Account (ERC6551): deploy treasury account
-    actor partner
-    loop
-        partner->>Token Bound Account (ERC6551): send $
-        Token Bound Account (ERC6551)->>partner: mint IOUs (ERC20)
-        Token Bound Account (ERC6551)->>Good Generator: remit funding received
-    end
-    loop
-        Good Generator-->Good Generator: implement project
-        Good Generator->>hypercert (ERC1155): submit evidence
-        Verifier--xhypercert (ERC1155): review evidence
-        Change Code--xhypercert (ERC1155): determine quantity
-        Change Code->>Token Bound Account (ERC6551): mint Change Credits (ERC721)
-    end
-    Loop
-        partner->>Token Bound Account (ERC6551): return IOUs
-        Token Bound Account (ERC6551)->>partner: receive Change Credits
-    end
-```
++++
diff --git a/change-credits/index.yml b/change-credits/index.yml
@@ -1,4 +1,4 @@
 icon: container
 expanded: true
-order: -1
+order: -3
 label: Change Credits
diff --git a/contributing/community-conduct.md b/contributing/community-conduct.md
@@ -0,0 +1,55 @@
+---
+label: Community Code of Conduct
+layout: page
+order: -1
+---
+
+# Community Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people;
+* Being respectful of differing opinions, viewpoints, and experiences;
+* Giving and gracefully accepting constructive feedback;
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience;
+* Focusing on what is best not just for us as individuals, but for the overall community;
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind;
+* Trolling, insulting or derogatory comments, and personal or political attacks;
+* Public or private harassment;
+* Publishing others' private information, such as a physical or email address, or revealing any pseudonymous identity without their explicit permission;
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Change Code's leadership is responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Change Code has the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+Enforcement of this code will sometimes be a challenging exercise in judgement and conflicting values. We recognize that members may not always agree with a given course of action or remedy, but Change Code commits to always being transparent in how decisions have been made.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+
+Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to Change Code's leadership at [weare@changecode.io](mailto:weare@changecode.io). All complaints will be reviewed and investigated promptly and fairly.
+
+Change Code is committed to respecting the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is modified from the Contributor Covenant, version 2.1, available [here](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
diff --git a/contributing/contribution-guide.md b/contributing/contribution-guide.md
@@ -0,0 +1,34 @@
+---
+label: Contribution Guide
+layout: page
+order: -2
+---
+
+# Contribution Guide
+
+## Community Conduct
+
+We are all people, all community members first, and developers second. All developers and other contributors agree to uphold Change Code's rules of [Community Conduct](./community-conduct.md).
+
+## Contributing
+
+Change Code strives to work in public and release code as open source whenever possible. If you would like to contribute to any of our repositories just follow the steps below.
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch-name`).
+3. Make your changes
+4. Commit any changes you've made (`git commit -am 'commit description'`).
+5. Push the code to your forked origin (`git push origin feature-branch-name`)
+6. Navigate back to the Change Code repository you forked from and create a new pull request.
+
+When making a pull request, do your best to describe the changes made and your motivations for doing so. While we're excited for your to participate alongside us, please understand that certain changes may not align with the our current roadmap or requirements. If we're unable to incorporate your work, we'll always do our best to explain why.
+
+To join our discussions, you can find us over on [Console](https://app.console.xyz/c/changecode). We always welcome new voices!
+
+## Issue Reporting
+
+If you have a feature request or encounter a bug in any of our work, we invite you to report it with a Github issue in the relevant repository. We've provided pre-templates to help improve reporting.
+
+## Commitment to Open Source Code
+
+Change Code is committed to open source code. The majority of our work is released under the [Mozilla Public License 2.0 (MPL2)](https://www.mozilla.org/en-US/MPL/2.0/).
diff --git a/contributing/index.yml b/contributing/index.yml
@@ -0,0 +1,4 @@
+icon: code-of-conduct
+expanded: true
+order: -6
+label: Community Conduct and Contributor Guide
diff --git a/retype.yml b/retype.yml
@@ -8,4 +8,7 @@ links:
 - text: Getting Started
   link: https://retype.com/guides/getting-started/
 footer:
-  copyright: "&copy; Copyright {{ year }} Change Code, Inc. All rights reserved."
+  copyright: "&copy; Copyright {{ year }} Change Code, Inc. All rights reserved."
+
+  editor:
+    enabled: false
