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

chore: update pr template #16297

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

iurimatias
Copy link
Member

What does the PR do

update PR template to include some of the new guidelines

@iurimatias iurimatias requested review from a team, 0x-r4bbit, virginiabalducci, Cuteivist, noeliaSD, Khushboo-dev-cpp and igor-sirotin and removed request for a team, 0x-r4bbit and noeliaSD September 9, 2024 15:24
@status-im-auto
Copy link
Member

status-im-auto commented Sep 9, 2024

Jenkins Builds

Commit #️⃣ Finished (UTC) Duration Platform Result
✔️ 4f09a39 #1 2024-09-09 15:31:25 ~6 min tests/nim 📄log
✔️ 4f09a39 #1 2024-09-09 15:34:59 ~10 min macos/x86_64 🍎dmg
✔️ 4f09a39 #1 2024-09-09 15:36:52 ~12 min tests/ui 📄log
✔️ 4f09a39 #1 2024-09-09 15:41:42 ~17 min linux-nix/x86_64 📦tgz
✔️ 4f09a39 #1 2024-09-09 15:42:35 ~17 min linux/x86_64 📦tgz
✔️ 4f09a39 #1 2024-09-09 15:43:23 ~18 min macos/aarch64 🍎dmg

@status-im-auto
Copy link
Member

- [ ] I have followed the architecture guidelines: [Architecture guidelines](../architecture-guide.md)
- [ ] For bug fixes, I have written a new unit test case to prevent reintroduction
- [ ] I have performed side impact testing for changes in shared components
- [ ] A reviewer has Tested the PR during review
Copy link
Contributor

Choose a reason for hiding this comment

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

these two might be better in a reviewer checklist, not sure if thats a thing though.

Copy link
Contributor

@igor-sirotin igor-sirotin left a comment

Choose a reason for hiding this comment

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

I think this is an overkill 👀
No way developers want to spend so much time on ticking every checkbox when opening the PR

- [ ] I have performed side impact testing for changes in shared components
- [ ] A reviewer has Tested the PR during review
- [ ] Given enough time for a thorough review

Copy link
Member

Choose a reason for hiding this comment

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

A little bit of feedback here:

  • Keep checkbox labels short, it's too much processing to read all of them
    • Example:
      • Has unit tests instead of I have written unit tests for status-go and QML changes
      • Has user stories instead of I have created stories for this feature/rework
      • Has storybook page (create if not existing) etc ...
  • The I have followed the architecture guidelines not sure this adds a lot of value here. While some of the points above can act as reminders (don't forget to add tests!) this one is more blurry.
  • Maybe instead of I have performed side impact testing... Add a section that says something like:

Side effects caused by these changes worth mentioning:

  • The A reviewer has tested this PR during review is something that should just be tackled by GitHub's "Request Review" feature, which implies the result in this checkbox automatically
  • The Given enough time for a thorough review is far fro quantifiable. If you want to have this guaranteed, it probably makes more sense to agree on a rule like: "Leave PRs at least # days pending for review, don't merge before"

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.

7 participants