mitodl / rapid-response-xblock

a django app plug-in for edx-platform

BSD 3-Clause "New" or "Revised" License

0 stars 2 forks source link

Updated installation instructions #89

Closed arslanashraf7 closed 3 years ago

arslanashraf7 commented 3 years ago

What are the relevant tickets?

Fixes #72

What's this PR do?

Updates the README and adds instruction on setting up & testing rapid-response-xblock.

Note: The changes in this PR are inspired/credited by a gist by @gsidebo, https://gist.github.com/gsidebo/32cfd743c928495b9b64c7562aaa635a

How should this be manually tested?

Following the instruction in the README should get one a working rapid response xblock.

codecov-io commented 3 years ago

Codecov Report

Merging #89 (cb87347) into master (82e25a3) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #89   +/-   ##
=======================================
  Coverage   90.77%   90.77%           
=======================================
  Files          16       16           
  Lines         607      607           
  Branches       42       42           
=======================================
  Hits          551      551           
  Misses         51       51           
  Partials        5        5

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 ae0db7f...fe4a861. Read the comment docs.

arslanashraf7 commented 3 years ago

Thanks so much for your attention to this. As I reviewed this, I ended up thinking of a lot of edits, mostly just for clarity and readability. There are enough edits that using a code suggestion doesn't make a lot of sense, so I created a gist. Let me know what you think. No guarantees on typos/inaccuracies 😅

https://gist.github.com/gsidebo/32cfd743c928495b9b64c7562aaa635a

@gsidebo Thanks a lot for the effort you put in for a detailed review on this and for creating the gist, I'll take a look at it and try to resolve typos/inaccuracies if any, and I'll rebase & update the PR with changes from that gist. I'm not sure, but I hope this might also help us update the description of Rapid Response on PyPI.