Skip to content

Commit

Permalink
doc: Course automation proposal (KTH#1008)
Browse files Browse the repository at this point in the history
  • Loading branch information
amarhod authored Mar 29, 2021
1 parent 942ea9c commit 6c08624
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions contributions/course-automation/amarh-ntas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Course automation: Essay bibliography check & summary
## Members
Amar Hodzic (amarh@kth.se)

Natan Teferi Assegehegn (ntas@kth.se)
## Proposal
We would like to create a Github Action that produces a PR comment with the number of references used as well as an excerpt from the reference list. This would simplify the TAs job in getting an overview without having to open the file and scroll down.
We are aware of another proposal that summarises essays but it has no mention of references.

What the Action should do:
* When a PR uses a specific label (e.g. essay), create a comment on that PR
* The comment should have a reference count
* The comment should include the reference list
* The reference list should be stripped down based on verbosity level set in the code (e.g. remove "accessed date", URL etc)

Criterias it should fulfill:
* Done before April 6
* The task produces a PR comment
* The task runs on a standard platform (Github Action)
* The task is praised by the other students of this course
* The code for the task is available and well documented

0 comments on commit 6c08624

Please sign in to comment.