Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: add bug_report.md #374

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

feat: add bug_report.md #374

wants to merge 1 commit into from

Conversation

mark-kascheev
Copy link

Changes

Added report template for clear bug reporting

Checklist for self-check

  • Commits and PRs have been filed according to the rules on the project.
  • The author is marked as an assigne and assigned mandatory reviewers.
  • Required labels marked
  • Specified related tasks and/or related PRs.
  • Specified Changes.
  • Attached videos/screenshots demonstrating the fix/feature.
  • All unspecified fields in the PR description deleted.
  • New code covered by tests.

Checklist for reviewers

  • CI passed successfully (with a green check mark).
  • PR is atomic, by volume no more than 400 (+-) corrected lines (not including codogen).

Design:

  • System design corresponds to the agreements on structure and architecture on the project.
  • The code is decomposed into necessary and sufficient components.

Functionality:

  • The code solves the problem.
  • Any changes to the user interface are reasonable and look good.

Complexity:

  • The code is clear, easy to read, functions are small, no more than 50 lines.
  • The logic is not overcomplicated, there is no overengineering (no code sections that may be needed in the future, but no one knows about it).

Tests:

  • Updated or added tests for mandatory components.
  • The tests are correct, helpful, and well designed/developed.

Naming:

  • The naming of variables, methods, classes and other components is understandable.

Comments:

  • The comments are understandable and helpful.

Documentation:

  • All labels are correct
  • Technical documentation updated (after approval, updates last reviewer).

@mark-kascheev mark-kascheev added the enhancement New feature or request label Feb 16, 2023
@mark-kascheev mark-kascheev self-assigned this Feb 16, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant