[Final submission] Course automation: check group of 3

contributions/course-automation/agnesfo-eryman/README.md

@@ -7,7 +7,7 @@ github: agnesforsberg
 Elin Ryman ([email protected]) 
 github: rymane
 
-### Group rules in this course regarding groups with 3 student.
+## Group rules in this course regarding groups with 3 student.
 "We recommend 2 students. Three is also possible for ambitious essays, demos or contribution to open-source."
 
 ## Proposal
@@ -18,7 +18,30 @@ which pull requests should be ambitious enough. We will also check that the pull
 demos or contributions to open-source since those categories are the only allowed for 3 students. 
 The Github Action should create a PR comment with information about if 3 students are ok for the chosen category.
 
-We aim to fulfill the following criterion: 
+## Submission
+This GitHub action looks at pull requests and checks if the number of studens is appropriate for the task. If the group size is 3 a comment will be added to the pull request regarding this is an acceptable task for that group size. Since the course has a requirement that groups of 3 need a remarkable submission our action also adds a label to the pull request if the group has 3 students so that the TAs can take a more careful look at the proposal.
+
+### Link to action repo
+https://github.com/rymane/group-of-3-action
+
+## Validation
+We have created pull requests to check the different use cases and make sure that they work.
+- [Test group of 3 students with valid task](https://github.com/rymane/group-of-3-action/pull/15)
+- [Test group of 3 students with unvalid task](https://github.com/rymane/group-of-3-action/pull/17)
+- [Test group of 2 students](https://github.com/rymane/group-of-3-action/pull/16)
+
+## Testing
+The directory **contributions** is made for testing. It contains 2 additional directories, named after valid tasks in the course. To test, perform these steps:
+
+1. Checkout a new testing branch
+2. Change something in one of the test files
+3. Commit and push the changes
+4. Create a new pull request
+
+This will trigger the workflow, and a comment will be written on the pull request. If the test was made on a "submission" with 3 names, a "GroupOfThree" label will also be added to the pull request. If the group size is change to 2 in a later stage, the "GroupOfThree" label is removed.
+
+We think we have fulfilled the following criterion: 
+
 
 |                                             | Yes | No | Remarkable  |
 |-------------------------------------------- | ----|----|-------------|
@@ -27,4 +50,5 @@ We aim to fulfill the following criterion:
 |The automation task is reusable | **Yes (next year for this course)** | No | In other courses than this one |
 |The task runs on a standard platform | **Yes**, will use Github action | No | Other platforms (e.g. Moodle, Canvas) |
 |The task is praised by the other students of this course | Yes | No | n-a |
-|The code for the task is available | **Yes**, will use a public repo | No | **Well documented repo** |
+|The code for the task is available | **Yes**, will use a public repo | No | **Well documented repo** |
+