search

SeedCompany / cord-api-v3

Bible translation project management API
MIT License
18 stars 4 forks source link

add pull request template #3133

Closed andrewmurraydavid closed 5 months ago

andrewmurraydavid commented 5 months ago

Reason for this PR

We discussed about trying out pull request templates in our repos.

Description

This PR adds the pull request file.

Ready for review checklist

Use [N/A] if the item is not applicable to this PR or remove the item

  • [N/A] Change the task url above to the actual Monday task
  • [N/A] Add/update tests if needed
  • [x] Add reviewers to this PR
andrewmurraydavid commented 5 months ago

Since I'm a visual learner, I thought I might be easer of myself and others who are also visual people, to display what that template would look like:

Monday task

Reason for this PR

In the case we don't have a monday ticket/task, we would justify the PR here.

Description

A description of the PR, its intended fixes or contribution and screenshot if helpful for review.

Steps to reproduce the bug

  1. In the case this would be a bug, we would add steps to reproduce it
  2. Otherwise we can leave this commented or remove the section

Expected behavior

Same goes for this, if the PR fixes a bug, we'd report the expected behavior for ease of review.

Ready for review checklist

Use [N/A] if the item is not applicable to this PR or remove the item

  • [ ] Change the task url above to the actual Monday task
  • [ ] Add/update tests if needed
  • [ ] Add reviewers to this PR
bryanjnelson commented 5 months ago

In regards to the "Reason for this PR" section...do we only use this if we don't have a Monday task?

andrewmurraydavid commented 5 months ago

In regards to the "Reason for this PR" section...do we only use this if we don't have a Monday task?

Not necessarily. I can see this being used in other use cases as well. Maybe if the task and/or story does not express any details as to what needs to be worked.

bryanjnelson commented 5 months ago

So "Reason for this PR" / Monday Task is more of the why...and the "Description" would be more of the what?

andrewmurraydavid commented 5 months ago

So "Reason for this PR" / Monday Task is more of the why...and the "Description" would be more of the what?

Correct. At least that's what I was envisioning. Happy to adapt it to something that would make more sense.