Skip to content

pull_request_template.md

Latest commit

 

History

History
61 lines (38 loc) · 1.9 KB

pull_request_template.md

File metadata and controls

61 lines (38 loc) · 1.9 KB

Labels (hint)

Choose the obligatory labels:

  • "ctg" (category): bug-fix, enhancement, refactoring, etc.
  • "comp" (component): symbolic-engine, fuzzing, codegen, etc.

Feel free to apply more labels to your PR, e.g.: lang-java, priority-minor, spec-performance

Title (hint)

Describe what you've changed or added in terms of functionality.

For example:

Add summaries for the nested classes

Support test generation for paths with spaces in JavaScript

Remove packageName property not defined in Java 8

Check that the title contains

  • no branch name
  • no GitHub nickname
  • no copy-pasted issue title

Description

Fixes # (issue)

Add more info if needed:

  • context/purpose for implementing changes
  • detailed description of the changes made

How to test

Automated tests

Please specify the automated tests for your code changes: you should either mention the existing tests or add the new ones.

For example:

The proposed changes are verified with tests: utbot-fuzzing/src/test/kotlin/org/utbot/fuzzing/FuzzerSmokeTest.kt

Manual tests

If it is impossible to provide the automated tests, please reason why. Usually, it is relevant only for UI- or documentation-related PRs. If this is your case, share the detailed manual scenarios that help to verify your changes.

Self-check list

Check off the item if the statement is true. Hint: [x] is a marked item.

Please do not delete the list or its items.

  • I've set the proper labels for my PR (at least, for category and component).
  • PR title and description are clear and intelligible.
  • I've added enough comments to my code, particularly in hard-to-understand areas.
  • 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.