Add usage section - Githubissues

slarse commented 3 years ago

There's essentially no information on how to use the plugin (e.g. example invocations to commands).

rjglasse commented 3 years ago

Furthermore the sanitize repo -h feedback was not so informative on the extra arguments that are required:

  --no-commit
  --target-branch TARGET_BRANCH

rjglasse commented 3 years ago

Just some notes from my first experience to help guide :)

As much of the work with RepoBee can be done remotely against repos on a template-org, it would be worth mentioning that we should be working within the repo locally (obvious in retrospect, but if you are used to use the template-org, this might be confusing, especially as some commands like setup do not like to be called from within a repo with a matching name)
There needs to be a clear description of where you should be when executing the commands, i.e. have checked out the solutions branch and targeting the master branch. I successfully nuked the solutions branch by getting this wrong the first time :)
And perhaps some "Finally, you should see this result" indicating that the master branch has been sanitized, can be pushed, and will have the Sanitize commit message, just so you know what to look for :)

repobee / repobee-sanitizer