Skip to content
This repository has been archived by the owner. It is now read-only.

Bounty #0 - Fix broken links, formatting, etc in READMEs - $2/fix #3

Closed
bwhm opened this issue May 27, 2019 · 71 comments
Closed

Bounty #0 - Fix broken links, formatting, etc in READMEs - $2/fix #3

bwhm opened this issue May 27, 2019 · 71 comments

Comments

@bwhm
Copy link
Member

@bwhm bwhm commented May 27, 2019

Problem

As the non-code repos are updated, it's difficult to avoid introducing broken links, errors with images, grammar mistakes, formatting errors, etc. This makes it difficult to navigate, and adds friction for readers. Note that this applies to ALL the README.md files, not just the top level one.

Goals

Improve quality and accessibility of our repos.

Rewards

$2 per fix that gets merged.

Substantial improvements may be rewarded extra.

Scope of Work & Deliverables

Fork the repo, and fix what is broken. Then make a PR in the applicable repo, and refer to it a reply answer in this issue.

Applicable repos are:

Constraints

  1. Although suggestions for clarifications, improvements, etc. are always welcome, please add them as comments instead of including them in the PR itself, to make the PR easier to review. If the reviewer agrees with your suggestion, you can add a new commit to the PR.

  2. All links within the same repo must be relative instead of absolute. Example:

# From https://github.com/Joystream/joystream/tree/master/testnets/acropolis
# You want to link to: https://github.com/Joystream/joystream/tree/master/meetings/acropolis#launch-meeting
# Do this:
[link](../../meetings/acropolis/#launch-meeting)
# Not this:
[link](https://github.com/Joystream/joystream/tree/master/meetings/acropolis#launch-meeting)
  1. When you start working, feel free to make a draft PR to show your intent, but preferably check the entire repo before
    Preferably go through all the links before marking it ready for review, and assigning someone to review your.

Update - 05.08.19

  1. Please use US English spelling for consistency across the organization.

  2. Ideally, use atom as your editor, and add the following plugins:

To ensure it renders correctly.

Bounty format

First come first serve. Pay out on delivery.
For our convenience, add a comment and link to the PR in this issue, with number of fixes and expected payouts.

Deadline

Will most likely be kept open for years. Will honor contributions 48h after closing.

@bwhm bwhm changed the title Bounty #0 - Fix broken links, images, grammar and formatting in READMEs - $2/fix Bounty #0 - Fix broken links, formatting, etc in READMEs - $2/fix May 27, 2019
@emmaodia
Copy link

@emmaodia emmaodia commented Jun 4, 2019

Joystream/helpdesk#31
Update made to the configure your validator keys for Linux section of the Readme.
@bwhm

XMR Wallet Address:
4A9b99HKPJrTdWTqoP1ejzgy4HVgMGDPncs3Mb6g8YQja8RAMUDyfPGDXiuo6E33Xthffu3FW8VqhVFR8kyry4kBJo3s6Kr

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jun 5, 2019

Joystream/helpdesk#31
Update made to the configure your validator keys for Linux section of the Readme.
@bwhm

Thanks for your contribution @emmaodia, paying out now!
($4)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 13, 2019

Joystream/joystream#79
Am going to do some grammar checks on the other four repositories so will add my XMR address later.

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 13, 2019

Have done the same with the other four qualifying repos:

Joystream/helpdesk#36
Joystream/communications#30
#16 (in this repository)
Joystream/design#11

XMR Address: 48E7bfe5ugnRY2G5akDyd3XQUM9NdqRKRcHSfyNMVtJSFuJt6KvowVZNqGL5CWUeewchmxS7nvHHGfhSLgRvyHJmLEsyvTr

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jul 13, 2019

Tyvm @blrhc
Will review and payout Monday at the latest.

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jul 15, 2019

@blrhc
Reviewed and merged. I counted 11 corrections, sending $22 your way :)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 15, 2019

@blrhc
Reviewed and merged. I counted 11 corrections, sending $22 your way :)

Thanks!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 15, 2019

Am including this one here for reference until it gets merged: Joystream/joystream#81

Also, I wanted to state here that I am planning to do some similar fixes on the https://github.com/Joystream/design repository as there don't seem to be any pending pull requests in that repository and there's only one README.

I subsequently hope to make detailed corrections to the READMEs of the other qualifying repositories, and will state my intention here when I'm about to do so.

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 15, 2019

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 16, 2019

I am now planning to work on a detailed spelling, grammar and formatting review of https://github.com/Joystream/bounties

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 16, 2019

Completed spelling, grammar and formatting review in this repository (#19).

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jul 16, 2019

Completed spelling, grammar and formatting review in this repository (#19).

Merged!
Do you mind if we wait and add the WIP one before I pay?

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 16, 2019

Completed spelling, grammar and formatting review in this repository (#19).

Merged!
Do you mind if we wait and add the WIP one before I pay?

Absolutely no problem! I may end up doing a formatting check on https://github.com/Joystream/communications/ tomorrow anyway, so there's definitely no rush!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Jul 16, 2019

Also noticed this one has been approved but not merged? Joystream/communications#30

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Jul 31, 2019

Hey. I submitted this: Joystream/helpdesk#38
I counted around 17 fixes, that should be paid. I did not include things like extra added space to this.
Here is my XMR address: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jul 31, 2019

@kek-mex
Sent! Thanks again for your contribution :)

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Jul 31, 2019

Also noticed this one has been approved but not merged? Joystream/communications#30

Sorry about the delay, just merged it now.

Also sorry for the delays regarding the Joystream/joystream#81
We weren't able to land the release plan before I left, and we decided to not merge the draft as I first intended...

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Aug 1, 2019

Sorry. Forgot to mention that im going to do a PR (Pull Request) on the bounties README.md soon. There is no any open PR's, so i guess that no damage was made :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Aug 2, 2019

I did create the next PR: https://github.com/Joystream/bounties/pull/23 I think that there are 10 fixes that should be merged/paid

My XMR address for the bounty is: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Aug 6, 2019

Im looking to fix some typos on the "communications" repo, and creating a PR for them.

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Aug 6, 2019

Fixed a few typos on Joystream/bounties#31
I count 3 typo's, that should be eligible for a reward.
XMR address: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Aug 7, 2019

Fixed a few typos on #31
I count 3 typo's, that should be eligible for a reward.

Thanks @kek-mex! Sending ASAP!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Aug 12, 2019

Am putting this one here now that it has been merged: Joystream/joystream#81

I count 40 significant edits in total (plus $10 bonus).

XMR Address: 48E7bfe5ugnRY2G5akDyd3XQUM9NdqRKRcHSfyNMVtJSFuJt6KvowVZNqGL5CWUeewchmxS7nvHHGfhSLgRvyHJmLEsyvTr

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Aug 13, 2019

@blrhc
Paid!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Aug 13, 2019

Thanks :)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Aug 14, 2019

evaluateing
Not in a README, but it is a spelling mistake (evaluateing vs evaluating).

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Nov 9, 2019

@kek-mex This will qualify for a $14 reward. I will confirm once the payout has been sent :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Nov 10, 2019

@kek-mex This will qualify for a $14 reward. I will confirm once the payout has been sent :)

Okay thank you once again :)
Edit: Received payment

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Feb 17, 2020

This PR was merged: Joystream/joystream#166.
I think that 7 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Feb 17, 2020

@kek-mex This qualifies for a $14 bounty. Will confirm once sent!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Feb 17, 2020

Sent!

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Feb 17, 2020

Sent!

Received thanks :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 17, 2020

I made a few changes to the helpdesk documentation: Joystream/helpdesk#49.
I think that 9 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Mar 18, 2020

Thanks @kek-mex, payment sent!
(@blrhc)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 19, 2020

@bwhm
Cheers! Payment received.

Also opened a new PR: Joystream/communications#43.
I think that 7 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 19, 2020

Joystream/communications#43.

Just checking those out now, thanks :)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 19, 2020

@kek-mex I have sent $14 to your XMR address to compensate for these fixes :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 21, 2020

This PR was merged: Joystream/joystream-content-system#5.
I think that 13 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 22, 2020

This PR was merged: Joystream/joystream-content-system#5.
I think that 13 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Paid :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 22, 2020

@blrhc
Thanks received! Here is the next one :)
Joystream/helpdesk#51.
I think that 6 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Loading

@kamalzaman
Copy link

@kamalzaman kamalzaman commented Mar 24, 2020

Joystream/helpdesk#57

Fix 9 missing links on TOC

XMR address:
46iSoXUuFnf3WBEjW3SEe7bHCjrR3geFqY1mwMNKUDBfJTATT4K72YETx4yT8FZpx2Zh8fADPZkxKSwQVNbc2vogK4AusFg

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 24, 2020

@blrhc
Updated a lot of stuff to Joystream/joystream: Joystream/joystream#193.
I think that 44 of these changes should be rewarded.
XMR addy: 47XDB7X3vvBCayY6grgkAzBVyzKDmMquFiuNr4DgsujaLjq8v3j7yJ5NBruXpEZhDgVcGhMo3x8ejiX6nwxThh4aG55QdzJ

Ps. I have not been paid for the Joystream/helpdesk#51 yet ;)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 25, 2020

Joystream/helpdesk#57

Fix 9 missing links on TOC

XMR address:
46iSoXUuFnf3WBEjW3SEe7bHCjrR3geFqY1mwMNKUDBfJTATT4K72YETx4yT8FZpx2Zh8fADPZkxKSwQVNbc2vogK4AusFg

Will count this as one fix if that's OK :)

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 25, 2020

Joystream/joystream#193.

Great work, will pay out in one go!

Loading

@kamalzaman
Copy link

@kamalzaman kamalzaman commented Mar 25, 2020

Joystream/helpdesk#57
Fix 9 missing links on TOC
XMR address:
46iSoXUuFnf3WBEjW3SEe7bHCjrR3geFqY1mwMNKUDBfJTATT4K72YETx4yT8FZpx2Zh8fADPZkxKSwQVNbc2vogK4AusFg

Will count this as one fix if that's OK :)

No problemo, just simple fix anyway

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 25, 2020

@kamalzaman @kek-mex Paid! Thanks for your contributions.

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 25, 2020

@kamalzaman @kek-mex Paid! Thanks for your contributions.

Actually, please confirm received?

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 25, 2020

@kamalzaman @kek-mex Paid! Thanks for your contributions.

Actually, please confirm received?

@kamalzaman Might have to wait until tomorrow, wallet empty :(

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 26, 2020

@kamalzaman @kek-mex Paid! Thanks for your contributions.

Actually, please confirm received?

Received. Cheers!

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Mar 26, 2020

Joystream/helpdesk#57

Fix 9 missing links on TOC

XMR address:
46iSoXUuFnf3WBEjW3SEe7bHCjrR3geFqY1mwMNKUDBfJTATT4K72YETx4yT8FZpx2Zh8fADPZkxKSwQVNbc2vogK4AusFg

@kamalzaman Paid :)

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Mar 28, 2020

@blrhc
Few changes to the bounties repo: Joystream/bounties#57.
I think that 4 of these changes should be rewarded. Please do check out my suggestion which I have added as a comment on that PR.

XMR addy: 47Y3J6LC8ibAeCLc6SZAUChhwLMDkiBHW7h2c6HHSUEZCuBBTb72Q7Mf5DzDEQhhsEiN5CktN7YzsWZYhwv4tDihAWX3NRF

Loading

@blrhc
Copy link
Contributor

@blrhc blrhc commented Apr 7, 2020

@blrhc
Few changes to the bounties repo: Joystream/bounties#57.
I think that 4 of these changes should be rewarded. Please do check out my suggestion which I have added as a comment on that PR.

XMR addy: 47Y3J6LC8ibAeCLc6SZAUChhwLMDkiBHW7h2c6HHSUEZCuBBTb72Q7Mf5DzDEQhhsEiN5CktN7YzsWZYhwv4tDihAWX3NRF

Sent!

Loading

@kek-mex
Copy link
Member

@kek-mex kek-mex commented Apr 7, 2020

@blrhc
Few changes to the bounties repo: Joystream/bounties#57.
I think that 4 of these changes should be rewarded. Please do check out my suggestion which I have added as a comment on that PR.
XMR addy: 47Y3J6LC8ibAeCLc6SZAUChhwLMDkiBHW7h2c6HHSUEZCuBBTb72Q7Mf5DzDEQhhsEiN5CktN7YzsWZYhwv4tDihAWX3NRF

Sent!

Thanks a lot! Received.

Loading

@lopegor
Copy link

@lopegor lopegor commented Mar 6, 2021

Hi!

I found several links that need fixing:

Loading

@bwhm
Copy link
Member Author

@bwhm bwhm commented Mar 7, 2021

Hey @lopegor,

This repo should have been archived already, but we have the "same" bounty running here!

If the Council fails to manage these within a reasonable timeline we'll make sure to honor it regardless!

Loading

@bwhm bwhm closed this Mar 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
8 participants