fullfact / .github Goto Github PK

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

We have some GitHub Guidelines now, which include guidance around branch naming, writing issues, referencing issues from pull requests etc.

Describe the solution you’d like

A pull request template would help serve as a reminder of these guidelines. It’s not perfect (e.g. I’m not sure it would be visible if the PR were created via a client like gh) but it’s probably the most useful place to put this information, where it’s most likely to be seen.

Executive summary

A short summary expanding on the issue title would be helpful, distinct from the full details.

Details

The instructions for the current ‘Overview’ section say:

<!--
  Give a high level overview and background of the feature,
  explaining why it is needed or what it enables. There should
  be enough detail for someone to pick up this ticket and
  understand the reason for the new feature and how it might
  be used by users. Who? What? Why?
-->

I think these instructions are good, but could maybe be split into two sections:

1. “a high level overview and background of the feature, explaining why it is needed or what it enables”. This could be the ‘executive summary’
2. “enough detail for someone to pick up this ticket and understand the reason for the new feature and how it might be used by users. Who? What? Why?” This could be called ‘details’.

I’m increasingly enthused about conventional commits, because
a) they help you do semver correctly and
b) they write nice changelogs for you

I wonder if we should link to this in the PR template, instead of the “good commit messages” thing.

Not all issues are fixed, some are closed! I propose the word "fixes" is replaced with "closed" in the issue template. Yes, I do believe in the strong Sapir-Whorf Hypothesis.

As suggested by @c-j-johnston in the last retro.

As @JamesMcMinn points out, this just means “not a bug” so it’s just label noise.