repobee / repobee-sanitizer

A plugin for sanitizing master repositories before distribution to students

MIT License

2 stars 3 forks source link

[docs] Include usage instructions in README #126

Closed tohanss closed 3 years ago

tohanss commented 3 years ago

Fix #120 Fix #119

codecov[bot] commented 3 years ago

Codecov Report

Merging #126 (cb4487d) into master (d7a22dc) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #126   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          252       252           
  Branches        43        43           
=========================================
  Hits           252       252

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 d7a22dc...3917943. Read the comment docs.

tohanss commented 3 years ago

@slarse I feel like maybe the new Command examples should come after the Example use cases, what do you think?

slarse commented 3 years ago

@tohanss I'll have a look tonight

slarse commented 3 years ago

@tohanss ping

dmusican commented 3 years ago

I just wanted to add that I very much appreciate that this PR is in progress. I was struggling to figure out what the typical use case was, and this draft straightened it out for me. So you're very much on the right track -- much appreciated.

slarse commented 3 years ago

@tohanss ping

tohanss commented 3 years ago

I implemented most of the suggestions with an exception for your suggestion @slarse:

It's most basic usage looks like so.

$ repobee sanitize repo --target-branch main

Where i think --no-commit is actually the most simple usage

slarse commented 3 years ago

I think this is a good start. We can polish the individual parts more with more PRs later.