-
Notifications
You must be signed in to change notification settings - Fork 216
doc: remove duplicate checklist #304
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
doc: remove duplicate checklist #304
Conversation
|
@jorydotcom I know you had mixed feelings about landing this change. Happy to close it just lmk |
599c7c9 to
c45563c
Compare
This removes the duplicated checklist in the issue template and instead links to the checklist in the new project application Fixes: openjs-foundation#288
c45563c to
c309634
Compare
|
Curious why you don't do that the other way round (i.e., keep the checklist in the issue template). |
|
@tobie the issue template is in a hidden directory |
|
Fair enough. |
|
Hmm, I definitely agree with removing the duplication but I think it makes more sense for the list to live in the template where it will actually be used and then we can link to the template from the application for folks to review it when reviewing the application process. Asking folks to copy/paste when creating the application issue sort of defeats the purpose of the template IMO. If others disagree and we decide to merge this, could we at least update the link to point to the raw markdown so that people can easily copy the list and paste it into the issue? Otherwise, it adds a step for people to find what they actually have to copy and could also lead to lists copied from the rendered HTML which isn't useful. |
|
I don't see a big problem with the duplication, we are likely not updating this very often. |
|
My suggestion is to remove the checklist from the proposal doc instead and add a link to the template there. That way when you create new issue you get the checklist and it is still discoverable through the proposal doc. |
|
The other option would be to clearly mark which of the two checklists is the canonical one. |
|
I've made two changes.
One thing to keep an eye out for... it seems like the copy from the application and the issue are already out of sync. Which version is canonical? |
|
The copy from the application should be considered the canonical version, IMO. The copy from the template is meant to provide more editorial context (where to find things) or specificity to avoid confusion and communicate intent. The one in the application was the one we approved though so it should be considered 'canonical' |
mhdawson
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
joesepi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
I plan to land this after today's meeting if there are no objections |
This removes the duplicated checklist in the issue template and
instead links to the checklist in the new project application
Fixes: #288