Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log documents in proc.review are not prompting editors to complete all edits #271

Open
thejayps opened this issue Oct 22, 2023 · 2 comments
Labels
essential Will cause failure to meet customer requirements. Assign resources. process To do with process or procedure

Comments

@thejayps
Copy link
Contributor

See #166 (comment)

@thejayps
Copy link
Contributor Author

thejayps commented Oct 22, 2023

A way to solve this could be to insist that all comments, defects, questions are listed in the "review changes" comments box when submitted at the end of checking. "Inline" comments/defects should also be noted and referenced in the full list in the comments box, because github causes these to be hidden after conversations are resolved. This could obscure the log history if elements of checking output are mentioned only inline.

The leader or scribe shoukd then copy and paste a full list from all checkers into a new comment box, then generate another new comment box for any defects found during logging. This means some duplication must be tolerated, but it ensures that the entire output of checking and logging is available to the editor in only 2 comment boxes

@rptb1
Copy link
Member

rptb1 commented Oct 23, 2023

In-line comments work OK for editing on GitHub because they show up as "unresolved conversations" in the pull request summary. You are forced to tick them off by closing each conversation. However, this could hide them from the leader during exit.

The leader or scribe shoukd then copy and paste a full list from all checkers into a new comment box, then generate another new comment box for any defects found during logging. This means some duplication must be tolerated, but it ensures that the entire output of checking and logging is available to the editor in only 2 comment boxes

That's similar to the tried-and-tested method of having the scribe log every issue.

I think it would be acceptable for the scribe to edit and append to a single comment with new issues. Then there would be a single comment / text block with a complete log, which would be a good thing.

I would strongly encourage linear numbering of that text with numbered list markup.

@thejayps thejayps added essential Will cause failure to meet customer requirements. Assign resources. process To do with process or procedure labels Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
essential Will cause failure to meet customer requirements. Assign resources. process To do with process or procedure
Projects
None yet
Development

No branches or pull requests

2 participants