Joystream Community Repo

A repo for community reports, tools and contributions.

Council Reports | Tokenomics Reports | Community Contributions

Table of Contents

• Overview
  • Workflow
    • KPI Related Submissions
    • Individual Submissions
    • Jsgenesis Submissions
    • Revisions & Improvements of Submissions
  • Current Directories
    • council-reports
    • community-contributions
    • tokenomics-reports
    • submission-log

Overview

The Joystream Community Repo is meant both as a resource for the community members of the Joystream project, and a place to submit their work or contributions.

If a KPI requires submitting a deliverable, eg. reports or some code, it is expected that a PR is made to this repo in order to qualify.

Although the community is meant to control the repo, Jsgenesis will approve and merge any pull requests for now. Note that the repo is licensed under GPLv3.

Workflow

The workflow for changing the repo depends on the reason and purpose behind the change. A consistent part is for the contributor to fork the repo, and create a pull request to the applicable branch.

KPI Related Submissions

When a KPI requires a deliverable to be successful, the following steps must be made:

• A pull request is made to the master branch.
• A proposal is made to the Joystream testnet.
  • The proposal (Text, or in some cases, Spending) contains a link to the PR and other relevant information
  • When (if) the proposal is voted through, @bwhm and @blrhc is tagged
  • The time of the latest commit will be used as the time of submission
• The PR is reviewed, and as long as it does not contain anything malicious or does not comply with license, it is merged.
• The submission is added to the Submission Log

Individual Submissions

If the deliverable is made by an individual, eg. for an existing or upcoming funding proposal, the following steps must be made:

• A pull request is made to the community branch, in a new folder within the Community Contributions directory.
  • Example: Bot project - Author Name
• A proposal is made to the Joystream testnet.
  • The proposal (Text, or in some cases, Spending) contains a link to the PR and other relevant information.
  • When (if) the proposal is voted through, @bwhm and @blrhc is tagged
• The PR is reviewed, and as long as it does not contain anything malicious or does not comply with the license of the repo, it is merged.
• The submission is added to the Submission Log

Jsgenesis Submissions

If a member of the Jsgenesis team wants to make changes to the repo, the following steps must be taken:

• A pull request is made to the master branch
• A Text proposal is made to the Joystream testnet.
  • The proposal contains a link to the PR and other relevant information
  • When (if) the proposal is voted through, the PR is merged.
• The submission is added to the Submission Log

Revisions & Improvements of Submissions

It is likely in the future we will have to accomodate revisions and improvements of previous submissions. This process will be refined when this becomes a necessary task.

Current Directories

council-reports

This folder can be used for creating council reports. The council reports submitted should be formatted in the following way: Council Round #n - DD/MM/YYYY - Council Report.md

community-contributions

This folder can be used for community coded bots and projects and anything that doesn't fit elsewhere. Each submission should be in a unique folder within this directory.

tokenomics-reports

This folder can be used for creating tokenomics reports, tokenomics reports are to be submitted during each Council Round. The tokenomics reports submitted should be formatted in the following way: Council Round #n - DD/MM/YYYY - Tokenomics Report.md

submission-log

This folder can be used for maintaining a log of submissions. If the testnet is started from fresh, a new file should be made. Each entry in the log should include the Joystream username of the submission, a link to the proposal, a link to the PR and the amount of tokens awarded to the user (if applicable). #1 - Rome Testnet - Community Repo Submission Log.md