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

[proposal] embed raised issues/PRs in paper page #1384

Open
sneakers-the-rat opened this issue Oct 30, 2024 · 2 comments
Open

[proposal] embed raised issues/PRs in paper page #1384

sneakers-the-rat opened this issue Oct 30, 2024 · 2 comments

Comments

@sneakers-the-rat
Copy link
Contributor

The opening instructions for reviews lightly encourage making comments in issues and pull requests, and I think those are often super valuable to authors, and a better way of tracking comments than in issue thread or in checklists.

Along with #1383 , I think we could improve the context of a work for our readers, give authors better feedback, and give reviewers more visible credit by making that a more official part of the review.

assuming it looks good and works well, what do yall think about

  • giving more explicit instruction to raise issues/PRs and link back to review issue
  • create a small informal tag typology for issues as per More structured recommendations for review issues? #1334
  • embed issues and PRs in paper pages on the website
    • initially collapsed, with single expand to open a pane to display collapsed titles/tags, then a second expand to open the issue/pr thread itself
    • using a tag like [minor] to exclude certain issues/PRs from the website so people weren't discouraged from making small comments

As before, I volunteer to implement this if we think its a good idea - and if I cant get a reasonably good impl then obvi we dont have to do it.

I think side benefit is that this also shows more of what joss reviews really look like if you havent followed the linkbacks from a review. The github interface actually makes it sort of hard to see all the linkbacks in a tidy way, so I and a few other reviewers I see just have to remember to list them all in our issue checklist to remember them all. Also good for editors for same reason.

@danielskatz
Copy link
Collaborator

Given that we have a variety of ways reviewers and authors communicate, and that this seems to be working to me, I don't see a reason to push actions in the software repo. Some reviewers are fine doing this, while others just want to leave comments in the review thread.

@sneakers-the-rat
Copy link
Contributor Author

Im not saying they stop, but for those that do want to make their reviews more visible and provide context on what was discussed during the review to future readers, this would provide a means of doing that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants