Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Please provide basic usage instructions for this action #22

Open
3 tasks
etcadinfinitum opened this issue Jun 14, 2020 · 1 comment
Open
3 tasks

Please provide basic usage instructions for this action #22

etcadinfinitum opened this issue Jun 14, 2020 · 1 comment

Comments

@etcadinfinitum
Copy link

Surprisingly, this repository doesn't have a README; this is a huge barrier to usability for instructors who haven't been following community chatter about this feature, and stands in stark contrast to GitHub's general philosophy about beautiful, robust, and useful documentation. Please create a README (or GitHub Pages site?) which, at a minimum, provides documentation of the following:

  • How this action works in tandem with the autograding config section of the Classroom assignment template UI
  • Configuring test cases in the Classroom environment (if this is how the tests should be configured?)
  • Setting up this action to run in student repositories
@stevenbitner
Copy link

I've taken a stab at a README for this project. It is in my fork at https://github.com/stevenbitner/autograding. Hope it helps someone.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants