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

Add PR template #190

Merged
merged 2 commits into from
Aug 23, 2024
Merged

Add PR template #190

merged 2 commits into from
Aug 23, 2024

Conversation

eyelidlessness
Copy link
Member

This is roughly based on the templates from:

  • getodk/central
  • enketo/enketo

It specifically adds a browser checklist, as that discussion is what prompted us to add this.


Before we merge this, I would like to consider adding:

  • A section to describe the PR's changes. This is something I'm trying to make an effort to do on at least non-trivial/non-obvious changes, and would like to encourage as it's really helpful to look back and find context for changes as they occur. This could be really basic, or could encourage specific kinds of details (e.g. things to look out for, things that were intentionally deferred, aspects of approach of particular interest/warranting particular scrutiny). If the latter, there may be overlap with the best solution section.
  • Either checkboxes for adding/skipping a changeset, or at least a text reminder. I'm hoping this will become more habitual over time, but for now it seems like it might be good to have the extra prompt.

Copy link

changeset-bot bot commented Aug 20, 2024

🦋 Changeset detected

Latest commit: e0fba71

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@sadiqkhoja sadiqkhoja left a comment

Choose a reason for hiding this comment

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

LGTM!

I also like the idea of adding "Changes" section in the PR

eyelidlessness and others added 2 commits August 23, 2024 08:48
This is roughly based on the templates from:

- getodk/central
- enketo/enketo

It specifically adds a browser checklist, as that discussion is what prompted us to add this.
(Speaking of wanting to include this in the PR template!)
@eyelidlessness eyelidlessness merged commit 1ce92a8 into main Aug 23, 2024
43 checks passed
@eyelidlessness eyelidlessness deleted the chore/pr-template branch August 23, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants