search

git4school / git4school-visu

Git4School, a dashboard for supporting teacher interventions in Software Engineering courses
https://git4school.firebaseapp.com/
Apache License 2.0
2 stars 3 forks source link

Documentation missing for commit message Closing keywords #73

Closed erikmd closed 3 years ago

erikmd commented 3 years ago

Description

I've recently tested Git4School for preparing some M1 GitHub assignment (thanks for developing this tool!), and it took me a long time to find the exact syntax of the commit message closing syntax.

(All the more as last week, the question chooser interface for selecting question markers was not that intuitive… but I've just seen that you enhanced the corresponding message in the meantime via 283b7410 :+1: :)

Steps to reproduce

On https://git4school.github.io/git4school-visu/index.html it is only written:

Filter commits by TP group or by resolved question […]

without further details.

Expected info

I was not sure whether the syntax was similar to that of GitHub, but I was able to found the snippet at stake: https://github.com/git4school/git4school-visu/blob/ddff00b77db776ce6bef08fee3831f29b8a540d2/src/app/models/Commit.model.ts#L160-L177

So I guess it'd be worth to document it, with some regexp or just sentences recapitulating these keywords…

To sum up, if I'm not mistaken, Git4School accepts all of these closing sentences (for each supported keyword Resolve etc.):

  1. Resolve ex1: random text, Resolve ex1 random text (with a colon or a space) or simply Resolve ex1
  2. Resolve #1: random text, Resolve #1 random text (with a colon or a space) or simply Resolve #1

and the main "advantage" of 2. items would be that the question markers #n can at the same time be issues numbers that the assignment topic could ask the students to create… if the teacher wishes it.

F0urchette commented 3 years ago

Hi, thanks for the issue ! There was indeed a lack of information on that side. The migration of the user documentation has just been done #76. On this occasion, the documentation has been reworked and I was able to integrate a note on the closing keywords here.

erikmd commented 3 years ago

Hi @F0urchette, OK thanks! so I guess I can close the issue :)