Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bwhm opened this issue May 27, 2019 · 14 comments

Comments

Projects
None yet
3 participants
@bwhm
Copy link
Contributor

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.

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.

Bounty format

First come first serve. Pay out on delivery.

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

This comment has been minimized.

Copy link

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

@bwhm

This comment has been minimized.

Copy link
Contributor Author

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!

@blrhc

This comment has been minimized.

Copy link
Contributor

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.

@blrhc

This comment has been minimized.

Copy link
Contributor

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

@bwhm

This comment has been minimized.

Copy link
Contributor Author

commented Jul 13, 2019

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

@bwhm

This comment has been minimized.

Copy link
Contributor Author

commented Jul 15, 2019

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

@blrhc

This comment has been minimized.

Copy link
Contributor

commented Jul 15, 2019

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

Thanks!

@blrhc

This comment has been minimized.

Copy link
Contributor

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.

@blrhc

This comment has been minimized.

Copy link
Contributor

commented Jul 15, 2019

@blrhc

This comment has been minimized.

Copy link
Contributor

commented Jul 16, 2019

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

@blrhc

This comment has been minimized.

Copy link
Contributor

commented Jul 16, 2019

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

@bwhm

This comment has been minimized.

Copy link
Contributor Author

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?

@blrhc

This comment has been minimized.

Copy link
Contributor

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!

@blrhc

This comment has been minimized.

Copy link
Contributor

commented Jul 16, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.