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

[Feature] Writing review Request issue template #9

Open
nsryan2 opened this issue Feb 4, 2025 · 1 comment · May be fixed by #10
Open

[Feature] Writing review Request issue template #9

nsryan2 opened this issue Feb 4, 2025 · 1 comment · May be fixed by #10
Assignees
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:3-Selected The assignee has chosen to work on this item next (after their current, in progress, issue) Type:Feature New feature or feature request

Comments

@nsryan2
Copy link
Member

nsryan2 commented Feb 4, 2025

Is your feature request related to a problem? Please describe.

With all of the writing we do, there's an expectation that issues accompany review requests and I do not believe the existing templates capture some of the unique information you would like to include regularly in such issues.

Describe the feature you'd like.

Some things I think the issue should include:

  1. The deadline for submission.
  2. The intended venue for the work.
  3. The pre-discussed timeline of events.
  4. A link to or attachment of a rendered pdf.
  5. Options for how feedback can be received.
  6. The anticipated response time to feedback on the part of the writer.
  7. [from Luke] Link to the writing checklist

Describe alternatives you've considered.

This is probably not necessary, but I just made an issue like this and thought it would be easy to do and helpful in a few cases where people want to make issues for their writing.

Additional context.

We currently have issue templates for bugs, features, and questions. I suppose, you could consider the features template, but I think I've outlined a set of information that would be easier to prompt in the few cases where we're reviewing writing.

How can this issue be closed?

This issue can be closed after the determination that it's not necessary (following a group/coffee chat discussion) or with a pr that adds this template.

@nsryan2 nsryan2 added Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Feature New feature or feature request labels Feb 4, 2025
@nsryan2 nsryan2 self-assigned this Feb 4, 2025
@nsryan2 nsryan2 added this to Meta Feb 4, 2025
@github-project-automation github-project-automation bot moved this to new in Meta Feb 4, 2025
@nsryan2 nsryan2 added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:3-Selected The assignee has chosen to work on this item next (after their current, in progress, issue) and removed Status:1-New No one has claimed this issue yet. It is in need of solving. labels Feb 4, 2025
@nsryan2 nsryan2 linked a pull request Feb 5, 2025 that will close this issue
9 tasks
@katyhuff
Copy link
Member

katyhuff commented Feb 5, 2025

I think this is a great idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:4-Low This work is valuable, but not urgent or mission critical. Status:3-Selected The assignee has chosen to work on this item next (after their current, in progress, issue) Type:Feature New feature or feature request
Projects
Status: new
Development

Successfully merging a pull request may close this issue.

2 participants