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

Update PR description template #472

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

dhriaznov
Copy link
Contributor

@dhriaznov dhriaznov commented Jun 12, 2023

πŸ”˜ PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Enhancement
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

πŸ“œ Background

Provide a brief explanation of why this pull request is needed. Include the problem you are solving or the functionality you are adding. Reference any related issues.

Issue Link: #[issue_number]
Context Link (if applicable): https://discord.com/channels/895889501560377364/938114005178916945/1116750424486187038

πŸ”„ Changes

Enumerate the changes made in this pull request, detailing what has been modified, added, or removed. Include technical details and implications if necessary.

Impact:

  • Explain the broader impact of these changes.
  • How it improves performance, fixes bugs, adds functionality, etc.

πŸ–Ό Screenshot / πŸ“Ή Video

Include screenshots or a video demonstrating the changes. This is especially helpful for UI changes.

βœ… Review checklist

Please ensure the following are true before merging:

  • Code Style is consistent with the project guidelines.
  • Code is readable and well-commented.
  • No unnecessary or debugging code has been added.
  • Security considerations have been taken into account.
  • The change has been manually tested and works as expected.
  • Breaking changes and their impacts have been considered and documented.
  • Code does not introduce new technical debt or issues.

@dhriaznov dhriaznov added the documentation Improvements or additions to documentation label Jun 12, 2023
@dhriaznov dhriaznov added this to the Sprint 35 - June 19 milestone Jun 12, 2023
@dhriaznov dhriaznov self-assigned this Jun 12, 2023

# πŸ”„ Changes
Enumerate the changes made in this pull request, detailing what has been modified, added, or removed. Include technical details and implications if necessary.
Copy link
Member

Choose a reason for hiding this comment

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

Would be good if we could also add what effect this could have within the service so that we think about and document what parts need to be QA'd in case of side effects.

Copy link
Member

@victorkirov victorkirov left a comment

Choose a reason for hiding this comment

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

This looks great πŸ‘ If we make the effort to fill this out with meaningful info, I think we would have a good, self-documenting history of changes.

@DuskaT021 DuskaT021 merged commit 27b8a72 into develop Jun 20, 2023
1 check passed
@m-aboelenein m-aboelenein deleted the denys/update-pr-description-template branch June 21, 2023 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants