SurfGear icon indicating copy to clipboard operation
SurfGear copied to clipboard

feat: add bug_report.md

Open mark-kascheev opened this issue 2 years ago • 0 comments

Changes

Added report template for clear bug reporting

Checklist for self-check

  • [x] Commits and PRs have been filed according to the rules on the project.
  • [x] The author is marked as an assigne and assigned mandatory reviewers.
  • [x] Required labels marked
  • [ ] Specified related tasks and/or related PRs.
  • [x] Specified Changes.
  • [ ] Attached videos/screenshots demonstrating the fix/feature.
  • [x] 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 avatar Feb 16 '23 12:02 mark-kascheev