Skip to content

Conversation

@MylesBorins
Copy link
Contributor

This removes the duplicated checklist in the issue template and
instead links to the checklist in the new project application

Fixes: #288

@MylesBorins
Copy link
Contributor Author

@jorydotcom I know you had mixed feelings about landing this change. Happy to close it just lmk

@MylesBorins MylesBorins force-pushed the remove-duplicate-list branch from 599c7c9 to c45563c Compare August 19, 2019 22:17
This removes the duplicated checklist in the issue template and
instead links to the checklist in the new project application

Fixes: openjs-foundation#288
@MylesBorins MylesBorins force-pushed the remove-duplicate-list branch from c45563c to c309634 Compare August 19, 2019 22:18
@tobie
Copy link
Contributor

tobie commented Aug 19, 2019

Curious why you don't do that the other way round (i.e., keep the checklist in the issue template).

@MylesBorins
Copy link
Contributor Author

@tobie the issue template is in a hidden directory .github and not super discoverable for folks aside from when the issue is created.

@tobie
Copy link
Contributor

tobie commented Aug 19, 2019

Fair enough.

@kborchers
Copy link
Contributor

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.

@mcollina
Copy link
Member

I don't see a big problem with the duplication, we are likely not updating this very often.

@mhdawson
Copy link
Member

mhdawson commented Aug 20, 2019

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.

@tobie
Copy link
Contributor

tobie commented Aug 20, 2019

The other option would be to clearly mark which of the two checklists is the canonical one.

@MylesBorins
Copy link
Contributor Author

I've made two changes.

  1. Add onboarding checklist back to template
  • added comment about when it had been copied and where from which should remind people to update
  1. I've moved the onboarding checklist from ./NEW_PROJECT_APPLICATION.md to ./PROJECT_PROGRESSION.md

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?

@jorydotcom
Copy link
Contributor

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'

@MylesBorins MylesBorins requested a review from jorydotcom August 28, 2019 20:10
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@joesepi joesepi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MylesBorins
Copy link
Contributor Author

I plan to land this after today's meeting if there are no objections

@MylesBorins MylesBorins merged commit 3fa9017 into openjs-foundation:master Sep 3, 2019
@MylesBorins MylesBorins deleted the remove-duplicate-list branch September 3, 2019 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Duplicate onboarding checklist

7 participants