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

docs: update readme, remove docker files and references #1178

Merged
merged 6 commits into from
May 12, 2021
Merged

Conversation

dionizh
Copy link
Contributor

@dionizh dionizh commented May 11, 2021

This change is Reviewable

Copy link
Contributor

@faucomte97 faucomte97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 4 of 4 files at r1.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @dionizh)


CONTRIBUTING.md, line 3 at r1 (raw file):

# Contributing Guidelines

Thanks for helping out Code For life's Rapid Router! Here are a few guidelines to help your contributions to be accepted :)

Capital L for "Life" pls


CONTRIBUTING.md, line 7 at r1 (raw file):

## Prerequisites

We use Zenhub to track our issues, you can find [our workspace here](https://github.com/ocadotechnology/rapid-router#workspaces/code-for-life-development-56f2afba6e54555c586f6db3/board?repos=39072690,22154147,18399425,49142916,219226351).

Do we want to specify that Zenhub needs to be added as Chrome extension?


README.md, line 10 at r1 (raw file):

## Code for Life and Rapid Router Overview

- Rapid Router is a [Code for Life](c4l) project, aimed at teaching primary-school children programming concepts through a vehicle routing

no hyphen between primary and school pls


README.md, line 11 at r1 (raw file):

- Rapid Router is a [Code for Life](c4l) project, aimed at teaching primary-school children programming concepts through a vehicle routing
  game.

Is this word on a new line?


README.md, line 21 at r1 (raw file):

## How to play

Go to [Code For Life website][c4l]. Register as either teacher or independent student. Go to Rapid Router to play.

Do we want to mention that signing up is optional to play the game?


README.md, line 43 at r1 (raw file):

### Mac

- Get the [brew](https://brew.sh/) package manager.

Don't you have to install Python on Macs too / wasn't there an issue that you had when setting up RR and portal to do with SQL or something?


README.md, line 84 at r1 (raw file):

You can also [submit a feature request][add-issue]. Make sure that you give us a suitable level of detail about the feature. Please note that we may not act upon all suggestions, if they are not in line with the direction
we want to take the project, or if we don't have the development resources to get it done.

Is this on a new line too?

@codecov
Copy link

codecov bot commented May 11, 2021

Codecov Report

Merging #1178 (0766440) into master (2ac9f28) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1178      +/-   ##
==========================================
+ Coverage   91.29%   91.30%   +0.01%     
==========================================
  Files         111      111              
  Lines        6200     6200              
==========================================
+ Hits         5660     5661       +1     
+ Misses        540      539       -1     
Impacted Files Coverage Δ
game/tests/test_random_road.py 98.23% <0.00%> (-0.89%) ⬇️
game/random_road.py 91.36% <0.00%> (+0.71%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ac9f28...0766440. Read the comment docs.

Copy link
Contributor Author

@dionizh dionizh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 2 of 4 files reviewed, 7 unresolved discussions (waiting on @faucomte97)


CONTRIBUTING.md, line 3 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Capital L for "Life" pls

Done.


CONTRIBUTING.md, line 7 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Do we want to specify that Zenhub needs to be added as Chrome extension?

Done.


README.md, line 10 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

no hyphen between primary and school pls

Done.


README.md, line 11 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Is this word on a new line?

Done.


README.md, line 21 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Do we want to mention that signing up is optional to play the game?

Done.


README.md, line 43 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Don't you have to install Python on Macs too / wasn't there an issue that you had when setting up RR and portal to do with SQL or something?

Done.


README.md, line 84 at r1 (raw file):

Previously, faucomte97 (Florian Aucomte) wrote…

Is this on a new line too?

Done.

Copy link
Contributor

@faucomte97 faucomte97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 2 of 2 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @dionizh)

@dionizh dionizh merged commit 11b645d into master May 12, 2021
@dionizh dionizh deleted the docsupdate branch May 12, 2021 15:08
@lauracumming lauracumming mentioned this pull request Jul 25, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants