Forked from Joystream/community-repo https://github.com/Joystream/community-repo
mochet
fef8c46397
Create bounty_10_revised_rules_draft.md
|
3 years ago | |
|---|---|---|
| community-contributions | 3 years ago | |
| council-reports | 4 years ago | |
| submission-log | 4 years ago | |
| tokenomics-reports | 4 years ago | |
| .gitignore | 4 years ago | |
| LICENSE | 4 years ago | |
| README.md | 4 years ago |
README.md
Joystream Community Repo
A repo for community reports, tools and contributions.
Table of Contents
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 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 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
- For general updates (updating links, text) these can just be gathered occasionally and submitted as a rolling update like this example: https://testnet.joystream.org/#/proposals/14 This does mean that it will take some time for the PRs to be approved by the council.
- In the event of some highly important change, a proposal could be made so that the matter is addressed more quickly than waiting for a rolling update
- If users want to be paid for updates or corrections, then they should open a PR (or multiple PRs) and link to it in a spending proposal, when this is approved it would have the same effect as approving the PR (which still has to be reviewed by Jsgenesis)
- As an example, if a user wants to add functionality to the telegram bot and be paid for it, they can open a PR and create a spending proposal linking to the PR
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
A repo for community reports, tools and contributions.
Table of Contents
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 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 Contributionsdirectory.- Example:
Bot project - Author Name
- Example:
- A proposal is made to the Joystream testnet.
- 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
Textproposal 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
- For general updates (updating links, text) these can just be gathered occasionally and submitted as a rolling update like this example: https://testnet.joystream.org/#/proposals/14 This does mean that it will take some time for the PRs to be approved by the council.
- In the event of some highly important change, a proposal could be made so that the matter is addressed more quickly than waiting for a rolling update
- If users want to be paid for updates or corrections, then they should open a PR (or multiple PRs) and link to it in a spending proposal, when this is approved it would have the same effect as approving the PR (which still has to be reviewed by Jsgenesis)
- As an example, if a user wants to add functionality to the telegram bot and be paid for it, they can open a PR and create a spending proposal linking to the PR
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