Code Monkey home page Code Monkey logo

clean_up_community-repo's Introduction

README.md doesn't have to be like this. We need to add a good description to the community repository

Draft repository organized you can see here

Root directory

  • bounties

  • community-contributions

  • council

  • documentation

  • working-groups

  • bounties-overview

    This is where bounties-status.json should be

  • bounties-reports

    Place for reports divided into folders

The Bounty reports submitted should be formatted in the following way: 
"Network"_Bounty_#n_Report_DD.MM.YYYY-DD.MM.YYYY.md

eg. Sumer_Bounty_#10_Report_12.08.2021-24.08.2021.md 
include check period

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

  • KPI

    The tasks of the KPI completed by the council should be located here

The KPI reports submitted should be formatted in the following way: 
"Network"_KPI_#n.n_"Name"_DD.MM.YYYY.md

eg. Sumer_KPI_#17.8_Clean_Up_Community_repo_24.08.2021.md 
  • council-reports

    This is where the council reports should be.

The council reports submitted should be formatted in the following way: 
"Network"_Council_Report_#n_DD.MM.YYYY.md

eg. Sumer_Council_Report_#12_16.08.2021.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)

  • tokenomics-reports

    This is where the tokenomics reports should be

The tokenomics reports submitted should be formatted in the following way: 
"Network"_Tokenomics_Report_#n_DD.MM.YYYY.md

eg. Sumer_Tokenomics_Report_#14_05.08.2021.md

This folder can be used for documentation. Any general accepted rules are found there

Any rules or reports related only to Working Groups should be here

  • curator_group
The Curator WG Leader reports submitted should be formatted in the following way: 
"Network"_Curator_Lead_Report_#n_DD.MM.YYYY.md

eg. Sumer_Curator_Lead_Report_#13_12.08.2021.md
  • operations_group
The Operations WG Leader reports submitted should be formatted in the following way: 
"Network"_Operations_Lead_Report_#n_DD.MM.YYYY.md

eg. Sumer_Operations_Lead_Report_#02_12.08.2021.md
  • storage_group
The Storage WG Leader reports submitted should be formatted in the following way: 
"Network"_Storage_Lead_Report_#n_DD.MM.YYYY.md

eg. Sumer_Storage_Lead_Report_#06_27.08.2021.md

Naming convention rules

Naming convention for folders

underscore_separated_words

  • all letters must be lowercase

Naming convention for files

Underscore_Separated_Words

  • all letters must be uppercase

  • Date - DD.MM.YYYY

clean_up_community-repo's People

Contributors

maxlevush-coinside avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.