code-annotation
code-annotation copied to clipboard
src-d
Annotations: add comments
Hi, It could be useful to add a comment section. In case of tough decisions - to keep reasons why it was annotated like this. In case of something confusing/broken - to keep it there so you don't need to switch context frequently: CAT -> issues -> CAT -> ...
When you say
CAT -> issues -> CAT
do you mean GitHub issues? If so, how could we offer something inside CAT to keep the Worker inside CAT?
Could you provide an example of the case CAT -> issues -> CAT?
Yes, GitHub issues in this particular case.
Could you provide an example of the case
CAT -> issues -> CAT?
Example: https://github.com/src-d/code-annotation/issues/174 - there are several suspicious diff/highlights. So I need to switch context not to lose the information that may help you to debug.
If so, how could we offer something inside CAT to keep the Worker inside CAT?
Add comments section (I think it's a good solution), so I can look through comment after I finish annotation and make issues and so on) + it will allow keeping some information for future.
If I understood you, your proposal will allow the following workflow:
- worker finds a tricky/complex/buggy/whatever filePair to annotate,
- worker press
skip with commentbutton -> leaves a comment attached to the filePair, and continues, - worker can retrieve a list of filePairs with a comment attached to proceed as needed.
You may need to add comments even to samples with a label. Example:
- https://github.com/src-d/code-annotation/issues/174#issuecomment-369170396 - keep track of files with suspicious/broken highlight.
- to keep information why labeling was done like this for a complex case.
Then you can go through DB and collects insights/logs/broken files/etc.
So instead of skip with comment it should be a kind of flag button to let the worker adding a comment into de filePair.
That way, the worker would be able to add a comment, and answer as similar/equal/different or just skip it