purescript-contrib / governance

Guidelines and resources for the PureScript Contributors organization
15 stars 3 forks source link

Track Update Checklist #32

Closed milesfrain closed 3 years ago

milesfrain commented 3 years ago

This is the current state of the update checklist from https://github.com/purescript-contrib/governance/issues/13#issuecomment-691368135

I'm making some updates to this, and will take this out of draft mode after that commit is added.

It seems best to track this in the repo, rather than overwriting the same comment a bunch of times.

milesfrain commented 3 years ago

Changes in the follow-up commit are:

  1. Linking to the actual directories and sections of interest in each issue template. For example:
    [docs](../blob/main/docs)
    [quick start](../#quick-start)
    -- alternatively
    [quick start](../blob/main/README.md/#quick-start)

This assumes all repos are using the main (versus master) naming convention. Should we make this another repo guideline? Edit: I see main is already a library guideline.

If the directory or section does not exist, this will produce a 404 error, but I assume the updater tool will create a placeholder for all of these.

  1. Removed changelog requirements from the docs issue template.

Should "missing changelog" be a separate issue template, or is it safe to assume that the updater tool will always create a changelog?

  1. Made some minor phrasing adjustments to clarify "real" tests, "completed" quickstart, "good"/"comprehensive" documentation.

The existing wording didn't really distinguish between autogenerated placeholders.

milesfrain commented 3 years ago

@thomashoneyman Should we edit this https://github.com/purescript-contrib/governance/issues/13#issuecomment-691368135 to just point to the tracked checklist to deduplicate?

thomashoneyman commented 3 years ago

Done! Good point!