diff --git a/_layouts/post.html b/_layouts/post.html new file mode 100644 index 0000000000000000000000000000000000000000..6a98655273f3db76d0064627dbdef915dce2ad02 --- /dev/null +++ b/_layouts/post.html @@ -0,0 +1,17 @@ +--- +layout: base +--- +
+
+ +
+
+

{{page.title}}

+
+ {{content}} +
+
+
+ +
+
\ No newline at end of file diff --git a/css/custom.css b/css/custom.css index 2e6bf6657809871c5d896a112397a24104ac93bc..f2c9696a034a991ec3a8cda1f1db163fe58a6729 100644 --- a/css/custom.css +++ b/css/custom.css @@ -989,12 +989,11 @@ body p, body blockquote, body ul { } a { - color: #ff7519; + color: #000; text-decoration: none; } a:hover, a:focus, a:active { - text-decoration: underline; outline: 0; } @@ -1461,6 +1460,10 @@ p { h1#main-h1 { font-size: 3rem; } + +h2 { + font-size: 1.4rem; + } h1 { font-size: 1.8rem; @@ -3012,14 +3015,37 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { word-wrap: break-word; } +.panel-segment a { + border-bottom: 2px dotted #a1aabb; + display: inline; + line-height: 1.7; +} + +.panel-segment a:hover, .panel-segment a:focus, .panel-segment a:active { + border-bottom: 2px solid #a1aabb; +} + + .panel-segment:last-child { margin-bottom: 1rem; } +.panel-segment h1 { + margin-top: 0; + margin-bottom: 2.5rem; + line-height: 1.2; + font-size: 2rem; +} + +.panel-segment h2 { + margin-top: 2.5rem; + text-align: left; +} + .panel-segment h3 { padding-top: 0; font-size: 1.5rem; - margin-top: 2.5rem; + margin-top: 1.7rem; font-family: 'Hind', sans-serif; font-weight: bold; } @@ -3028,7 +3054,7 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { margin-top: 0; } -.panel-segment p { +.panel-segment p, .panel-segment ul li, .panel-segment ol li { padding-top: 1rem; font-size: 1.1rem; line-height: 1.7; @@ -3041,12 +3067,6 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { margin-bottom: 0; } -.panel-segment ul li, .panel-segment ol li { - font-size: 1.1rem; - line-height: 1.7; - padding-top: 1rem; -} - .panel-segment .gldiscuss { padding-top: 2.5rem; margin-top: 3rem; @@ -3103,10 +3123,18 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { .milestone.panel-segment:first-of-type, .milestone.panel-segment:after { padding-top: 3rem; } + +.panel-segment h2 { + margin-top: 2.3rem; +} .panel-segment h3 { font-size: 1.3rem; - margin-top: 2rem; + margin-top: 1.5rem; +} + +.panel-segment h1 { + margin-bottom: 2rem; } .panel-segment .gldiscuss { @@ -3140,14 +3168,23 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { padding-top: 2rem; } -.panel-segment p { +.panel-segment p, .panel-segment ul li, .panel-segment ol li { font-size: 1rem; } + +.panel-segment h2 { + margin-top: 2rem; +} .panel-segment h3 { font-size: 1.3rem; margin-top: 1.5rem; } + +.panel-segment h1 { + margin-bottom: 1.5rem; + font-size: 1.7rem; +} .panel-segment .gldiscuss { padding-top: 1.5rem; @@ -3164,6 +3201,10 @@ p.author-list, p.date-list, p.progress-number-goal, p.bar-work-status { .panel-segment:first-of-type, .milestone.panel-segment:first-of-type { } + +.panel-segment h1 { + font-size: 1.5rem; +} .input:checked + .label { padding-bottom: 0; diff --git a/how-to-css/index.md b/how-to-css/index.md new file mode 100644 index 0000000000000000000000000000000000000000..fe4bb67de34261d9dde8bf67c76890a8558cd746 --- /dev/null +++ b/how-to-css/index.md @@ -0,0 +1,213 @@ +--- +layout: post +title: How to submit a CCS proposal. +--- + +The CCS utilizes git, and Monero's Gitlab instance for proposal tracking. A quickstart guide is provided at the top for those already well-versed in git, and step-by-step instructions (with pictures) are provided afterward for those who need help getting through the process. An example proposal is provided at the bottom of this document for referential purposes. + +## Table of Contents +- [Quickstart Guide](#quickstart-guide) +- [Step-by-step Instructions](#step-by-step-instructions) +- [Example Proposal](#example-proposal-front-matter) +- [Editing or Amending a Proposal](#editing-or-amending-a-proposal) + +## Quickstart Guide +1. Register for an account on [Monero's Gitlab instance.](https://repo.getmonero.org) and fork the [CCS Proposals repository](https://repo.getmonero.org/monero-project/ccs-proposals) +2. Make a new branch, named similarly to your proposal +3. Add a new `.md` document, and title it similarly to the title of your proposal with your name or handle in the file name. +4. Use the template provided below for the front matter, and place it at the top of your proposal. You are responsible for adding the appropriate amount of milestones, with an equal number of payouts below the milestones. FORMATTING MUST BE PRESERVED, OR THE PROPOSAL WILL NOT WORK! Do NOT fill in the `done:` variable under `milestones:`, and do NOT fill in anything under `payouts:` besides making sure the number matches the number of milestones. +``` +--- +layout: fr +title: +author: +date: +amount: +milestones: + - name: + funds: + done: + status: unfinished + - name: + funds: + done: + status: unfinished +payouts: + - date: + amount: + - date: + amount: +--- +``` +5. Underneath the front matter, write the rest of your proposal. Be sure to include what the proposal is about, who will be completing it, why it is important for the community, the milestones and projected timeline, and an expiration date for your proposal. +6. Save, commit, and make a Merge Request to the repo. Your MR title must be descriptive and relevant to your proposal. +7. You're done. Go start letting people know about your proposal. + +## Step-by-step Instructions + +### 1. Gitlab + +**You will only have to do this step once! If you make future proposals, you can skip to Step 2.** + +First things first, you're going to need an account on [Monero's Gitlab instance.](https://repo.getmonero.org) Following the provided link will bring to the sign up page. Register for an account (use a strong password), and then navigate to the [CCS Proposals repo](https://repo.getmonero.org/monero-project/ccs-proposals). Click the "Fork" button and select your name on the subsequent screen. ![Click this fork button](/img/how-to/fork.png) + +You should see a blue success bar, along with your new repository. ![Fork success](/img/how-to/fork-success.png) + +### 2. Branches + +If you're not familiar with git, then this next step might not make a lot of sense to you, but it is common and recommended practice for users of git and Gitlab. Basically, just do this, even if you don't understand it. It makes the maintainer's lives a lot simpler. + +Click on Branches. ![Click on Branches](/img/how-to/branches.PNG) and then click on New Branch. ![Click on NEw Branch.](/img/how-to/new-branch.PNG) Fill in the "Branch Name" on the next screen by naming it something similar to your proposal. No spaces are allowed though. Leave the other field as is (it should say "Master") and click Create Branch. You should be taken back to your repository, but now on the new branch, as evidenced by seeing the name of your new branch on the screen. A screenshot is provided below to show where you would see it. ![Hooray! You're on your new branch.](/img/how-to/new-branch-success.PNG) + +### 3. Make the proposal file + +From here, you're going to click on the + button near the top center of your screen, and click "New File" on the subsequent dropdown. ![Plus button](/img/how-to/new-file.PNG) On this new screen, fill in the File Name field with a descriptive title that includes your name, or online handle, is relevant to your proposal, and ends in `.md`. As an example, if Diego "rehrar" Salazar was to make a proposal asking for funding so I can make videos for Monero, I might title the file `rehrar-make-videos-for-monero.md`. + + +### 4. Front matter + +Before you begin writing your proposal, however, you must copy the following template and paste it onto the top of your file: +``` +--- +layout: fr +title: +author: +date: +amount: +milestones: + - name: + funds: + done: + status: unfinished + - name: + funds: + done: + status: unfinished +payouts: + - date: + amount: + - date: + amount: +--- +``` + +Fill this template out as follows: + +`layout:` Do NOT touch this field. + +`title:` Fill this in with a descriptive title of what your proposal wants to accomplish. Copy this field into a notepad program, as the EXACT title will be used in Step 6. + +`author:` Put your name or handle here. + +`date:` Put the date you are proposing and submitting this to the community in the following format: `January 31, 2019`. + +`amount:` Put the amount of Monero you are requesting for complete this. + +`milestones:` Do not put anything after Milestones directly, but rather the fields that follow it. Copy and paste from one dash (`-`) to the other, depending on how many milestones your proposal will take. So if you have four milestones, you should see put the following: +``` +milestones: + - name: + funds: + done: + status: unfinished + - name: + funds: + done: + status: unfinished + - name: + funds: + done: + status: unfinished + - name: + funds: + done: + status: unfinished +``` +EXACT FORMATTING MUST BE PRESERVED WITH THE SPACING. Otherwise the proposal will not work. It's the way Jekyll (on which this is built) functions. The dashes must be two spaces from the left margin. + +Fill in the `name:` field with the name of the Milestone (for example: Complete Video 1), and the `funds:` field with the amount of Monero you expect to receive for completing the milestones. Do not touch the `done:` or `status:` fields. Repeat until all the `name:` and `funds:` fields are filled in. If this confuses you, please scroll to the end of the page for an example of all of this correctly filled out. + +`payouts:` Copy and paste the same amount of variables under payouts that you have under milestones. If you have three milestones, you should have three sets `date:` and `amount:` variables underneath `payouts:`. Do not fill in these fields. + +### 5. Writing your proposal + +NOW you can put your proposal beneath the front matter (underneath the last three dashes). When writing the proposal remember to include: + +- What the proposal is about. +- Who will complete the proposal? +- Why it is important for Monero and the community. +- Your milestones and projected timeline +- An expiration date for the proposal. If it's not funded or finished by a certain time, the funds can be released to other proposals or the General Fund.. This keeps things moving along in a timely fashion. + +It is recommended that after your proposal is written, you copy and paste it (minus the front matter from step 4) and paste it into a notepad. This will be used in step 6. + +After all of this is done, click the green Commit Changes button at the bottom. + +### 6. Make a Merge Request + +After you click Commit Changes, you will be taken to your newly created file in the new branch of your repository. You will see a bar at the top that lets you know the creation of your file has been successful. You will also see a notification that your new branch can make a Merge Request. + + +Click on the blue button in the upper right to start this process. ![File creation success and merge request button](/img/how-to/mr.PNG) + +You will see a screen with a few things to fill out. In the Title field, put the same title that you used in the front matter of your proposal. In the Description text box, paste in the proposal EXACTLY AS IT APPEARS IN YOUR .md file, minus the front matter. If you followed Step 5, you should have it in a notepad program of some sort. ![Fill in title and description fields](/img/how-to/submit-mr.PNG) + +After this is done, scroll down, and click the green Submit Merge Request button at the bottom left of the page. You should be taken to the Merge Request page for your proposal. + +### 7. You're done. Now go drum up some support. + +Good job on getting all the way here. When you finish, the community will be discussing your proposal on the merge request itself. If you want to weigh in on the discussion, feel free. It will be up to you to get people to support your proposal, both for it to be moved to the Funding Required stage, and also while its awaiting donations. Best of luck, and thank you so much for contributing to Monero. We, the community, really appreciate it. + +## Example Proposal Front Matter + +``` +--- +layout: fr +title: Make a Monero Spaceship +author: somekid +date: January 31, 2019 +amount: 10000 +milestones: + - name: Milestone 1 - Purchase the parts + funds: 30% (3000 XMR) + done: + status: unfinished + - name: Milestone 2 - Assemble the spaceship + funds: 50% (5000 XMR) + done: + status: unfinished + - name: Milestone 3 - Throw a big party + funds: 20% (2000 XMR) + done: + status: unfinished +payouts: + - date: + amount: + - date: + amount: + - date: + amount: +--- +``` + +The proposal will be written here. + +## Editing or Amending a Proposal + +Often times, through community critique and feedback, it is necessary to edit a proposal after the Merge Request has already been submitted. This can be done in the following way. + +### Navigate to your CCS Proposals repository + +From the homepage of repo.getmonero.org, once you're logged in, you should see a list of your repositories. Find your copy of `CSS Proposals` and click on it. + +### Branches and files + +Locate the dropdown with all of your active branches, click it, and select the branch on which your proposal was made. ![Branches dropdown](/img/how-to/edit-find-branch.PNG) + +Once you are on the page with the correct branch, as evidenced by the name of the branch showing (see the last screenshot in step 2 of the step-by-step instruction to see where) find and select the file of your proposal (this is why descriptive branch and file names are important). + +### Editing the file + +Once you are on the page of your file, on the upper right corner should be an Edit button. ![Edit button](/img/how-to/edit-edit-button.PNG) Select this and you should be taken to the editing screen. Amend the proposal as needed (remember to edit the front matter too if any of those variables are changing), and press the green Commit Changes button at the bottom. + +**Warning! Not only the changes but THE FACT that you made changes will be visible to EVERYONE! You CANNOT stealth edit your proposal. This is good for transparency. See the screenshot below.** ![Edits seen](/img/how-to/edit-editing-seen.PNG) \ No newline at end of file diff --git a/ideas/index.html b/ideas/index.html index 3b860945242e3bf98ea9474ec8b2106a3eb7610e..ac406a2bac419651b4c66f0c00a80eb9e6403d55 100644 --- a/ideas/index.html +++ b/ideas/index.html @@ -9,7 +9,7 @@ title: Ideas

Community Crowdfunding System

{{page.title}}

- Submit Idea + Submit Idea

diff --git a/img/how-to/branches.PNG b/img/how-to/branches.PNG new file mode 100644 index 0000000000000000000000000000000000000000..0c693f3807798e6807ec11c82ac49383c070c55d Binary files /dev/null and b/img/how-to/branches.PNG differ diff --git a/img/how-to/edit-edit-button.PNG b/img/how-to/edit-edit-button.PNG new file mode 100644 index 0000000000000000000000000000000000000000..8b21d976ade0578bf6d6097cbdbfe43ed17e7256 Binary files /dev/null and b/img/how-to/edit-edit-button.PNG differ diff --git a/img/how-to/edit-editing-seen.PNG b/img/how-to/edit-editing-seen.PNG new file mode 100644 index 0000000000000000000000000000000000000000..45520b21066761b30cb7ed9d3f2db476d2a8d88d Binary files /dev/null and b/img/how-to/edit-editing-seen.PNG differ diff --git a/img/how-to/edit-find-branch.PNG b/img/how-to/edit-find-branch.PNG new file mode 100644 index 0000000000000000000000000000000000000000..8c6a7166d2675ed4060e7e66eebcd994196ffe19 Binary files /dev/null and b/img/how-to/edit-find-branch.PNG differ diff --git a/img/how-to/fork-success.png b/img/how-to/fork-success.png new file mode 100644 index 0000000000000000000000000000000000000000..ca47394225c46329275f002938f3b0f5abf38300 Binary files /dev/null and b/img/how-to/fork-success.png differ diff --git a/img/how-to/fork.png b/img/how-to/fork.png new file mode 100644 index 0000000000000000000000000000000000000000..44197df705ed1d57040f28bfe081b55d6ef81577 Binary files /dev/null and b/img/how-to/fork.png differ diff --git a/img/how-to/mr.PNG b/img/how-to/mr.PNG new file mode 100644 index 0000000000000000000000000000000000000000..0a4c1e1e474095fc9f99688c7e18801f871fd4a6 Binary files /dev/null and b/img/how-to/mr.PNG differ diff --git a/img/how-to/new-branch-success.PNG b/img/how-to/new-branch-success.PNG new file mode 100644 index 0000000000000000000000000000000000000000..3572e53f4532d46b386ccf80955e5f3eda2570f9 Binary files /dev/null and b/img/how-to/new-branch-success.PNG differ diff --git a/img/how-to/new-branch.PNG b/img/how-to/new-branch.PNG new file mode 100644 index 0000000000000000000000000000000000000000..216a49543b3167eacb814718060898e2c257debc Binary files /dev/null and b/img/how-to/new-branch.PNG differ diff --git a/img/how-to/new-file.PNG b/img/how-to/new-file.PNG new file mode 100644 index 0000000000000000000000000000000000000000..2da7167362e41bf096871067c7bc6e100d6a5eae Binary files /dev/null and b/img/how-to/new-file.PNG differ diff --git a/img/how-to/submit-mr.PNG b/img/how-to/submit-mr.PNG new file mode 100644 index 0000000000000000000000000000000000000000..17ad84fac0f4f70885198d4f591834ce0d96ede8 Binary files /dev/null and b/img/how-to/submit-mr.PNG differ diff --git a/index.md b/index.md index f162e2800a98dfd68716df399eea0b3fb1c91864..3d4ca05dce4f27e7d3cd5c9fd9193d1ae47f26f6 100644 --- a/index.md +++ b/index.md @@ -7,7 +7,7 @@ title: Community Crowdfunding System (CCS)

{{page.title}}

-

Monero is a decentralized community-driven project, and the CCS is a way for members to get involved and proposals to be funded. To see how it works, click here. To see how to submit your own proposal or idea, click here.

+

Monero is a decentralized community-driven project, and the CCS is a way for members to get involved and proposals to be funded. To learn more about what it is and what the rules are, click here. To see how to submit your own proposal or idea, click here.

diff --git a/what-is-ccs/index.md b/what-is-ccs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..014371027347b78bb43dbb48cd031d7ffe7f0715 --- /dev/null +++ b/what-is-ccs/index.md @@ -0,0 +1,52 @@ +--- +layout: post +title: What is the CCS and what are its rules and expectations? +--- + +## Introduction + +In the cryptocurrency sphere there are many ways that projects try to fund their efforts. In recent years a veteran of the space may have heard terms such as ICO, Founder's/Dev Fee, Decentralized Treasury, and more. + +The Monero Project, which is itself a decentralized project without formalized leadership or governance structures, is unable or unwilling to partake in any of the above funding methods, and has looked for a more decentralized method of both raising and dispersing funds that doesn't compromise the ideals of the community. The result is the Community Crowdfunding System (CCS) formerly known as the Forum Funding System (FFS). + +There are many different types of proposals, all with their own goals in mind. In the past, we have seen things from coding new software, developing third party resources, travel reimbursement for conference presenters, and hiring skilled individuals for full-time or part-time work. + +The CCS is a way for the community to propose ideas, request money, and utilize the services of the Core Team as an escrow. + +## CCS Proposal Standard Flow + +The standard CCS workflow is as follows: + +1. An individual or team (henceforth 'proposer') has an idea to improve the Monero ecosystem that requires funds. +2. The proposer types up a CCS proposal, understanding the rules and expectation presented in the following section, and makes a Merge Request (MR) to the CCS Proposals repository on Monero's Gitlab instance. All steps to submit this Merge Request can be found [here](/how-to-css/). +3. The community discusses the pros and cons of the proposal, and offers feedback and critique. +4. The proposer changes the proposal (if necessary) utilizing the feedback and critique of the community. +5. Repeat steps 3 and 4 as needed. +6. After the Core Team has determined that the community has reached loose consensus, the MR is merged, and funding begins. +7. Once fully funded (not guaranteed), the proposal is moved to Work in Progress, where the team begins on the work, if they haven't already. +8. Milestones are completed, and funds are dispersed upon their completion. +9. After all milestones are completed, the proposal is moved into Completed Proposals, where all info is retained for posterity. + +## CCS Rules and Expectations + +The CCS is intentionally left as informal as possible. This allows for flexibility of the system, and keeps things from being red taped into oblivion. However, there are some things you should understand, things that will be expected of you, as either a proposer or a donor, and a recommended way of structuring a proposal for maximum likelihood that your project will be funded. + +### For Donors + +1. The CCS is escrowed by the Core Team. When you make a donation, you are releasing funds to them to disperse when they deem the community agrees that a milestone is complete. They do not do the work to verify donors, and the final decision for all disputes falls with them, although they do their best to follow community sentiment. +2. In the event that a proposal is overfunded, unable to be completed, or otherwise put in a state where donated money will not be dispersed to the intended recipient, the default is that the remaining XMR will be put in the Monero General Fund. There are some exceptions, but they are rare, and these decisions rest with the Core Team. +3. Refunds are extraordinarily rare. Donate accordingly. +4. If the proposer disappears, no problem, someone else can pick up from their last milestone + +### For Proposers + +1. There is no guarantee that your project will get past the Ideas stage, and if it does, there is no guarantee that it will be funded. +2. You have to drum up support for your proposal during the first two stages. Do not expect others (especially the Core Team or other trusted members of the community) to do it for you. Others may share and support if they are excited about your project, but ultimately it is nobody's responsibility but your own. +3. It is expected that you provide updates on the progress of your proposal to the community. For every milestone completed there should be a written report put into the Gitlab comments of your proposal announcing its completion and the work done, but depending on the timeline of your project, it may be wise to update the community more frequently, such as at the biweekly community or dev meetings. +4. All work must be licensed permissively at all stages of the proposal. There is no time where your work can be licensed under a restrictive license (even as you're working on it). Your proposal will be terminated if this is not remedied. +5. You may NOT under any circumstances include a donation address directly in your proposal. This circumvents the CCS, and can lead to scams. +6. Your work on the project can begin before the proposal is fully funded, and milestones may (at times) be paid out before the proposal is fully funded. + +### How to submit a proposal + +[Please read this page for step-by-step instructions on how to submit a proposal.](/how-to-css/) \ No newline at end of file