Skip to content

Update PR template with requirements for labels and titles#1714

Merged
olganaumenko merged 3 commits into
mainfrom
olganaumenko/PR_template_revision
Jan 20, 2023
Merged

Update PR template with requirements for labels and titles#1714
olganaumenko merged 3 commits into
mainfrom
olganaumenko/PR_template_revision

Conversation

@olganaumenko
Copy link
Copy Markdown
Collaborator

@olganaumenko olganaumenko commented Jan 19, 2023

Description

Previously, it took a lot of time to classify PRs based on the type of change and the related component. To streamline release process, reviewing and contributing, we introduce the PR template with the requirements for using labels and giving titles, and the new self-check list.

How to test

Manual tests

The PR introduces no code changes.
Manual scenario: the text itself has been previewed in the IntelliJ IDEA viewer.

Self-check list

  • I've set the proper labels for my PR.
  • PR title and description are clear and intelligible.
  • I've added enough comments to help people understand my code.
  • The functionality I've repaired, changed or added is covered with automated tests.
  • Manual tests have been provided optionally.
  • The documentation for the functionality I've been working on is up-to-date.

@olganaumenko olganaumenko added ctg-enhancement New feature, improvement or change request comp-infrastructure Infrastructure issues labels Jan 19, 2023
Comment thread .github/pull_request_template.md Outdated

Check off the item if the statement is true:

- [ ] I've set the proper **labels** for my PR.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would add here:
(at least, category and component)

Copy link
Copy Markdown
Member

@alisevych alisevych left a comment

Choose a reason for hiding this comment

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

Looks very good to me. Only minor corrections suggested.

Comment thread .github/pull_request_template.md Outdated

- [ ] I've set the proper **labels** for my PR.
- [ ] PR **title** and **description** are clear and intelligible.
- [ ] I've added enough **comments** to help people understand my code.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would suggest to leave "particularly in hard-to-understand areas" - seems that we try to avoid unnecessary commenting.

@olganaumenko olganaumenko merged commit 35fa737 into main Jan 20, 2023
@olganaumenko olganaumenko deleted the olganaumenko/PR_template_revision branch January 20, 2023 08:00
@alisevych alisevych added this to the 2023.03 Release milestone Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp-infrastructure Infrastructure issues ctg-enhancement New feature, improvement or change request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants