From e105afb3bd4740a44d4fc6986e4a1b56d07f3017 Mon Sep 17 00:00:00 2001 From: Denis Fokin Date: Wed, 25 May 2022 10:43:30 +0300 Subject: [PATCH 1/4] Update feature templates --- .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..78f78dfb58 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request +about: Suggest an idea for the UTBot project +title: '' +labels: '' +assignees: '' + +--- + +**Please, describe the problem to be solved** + +Substitute this text with a concise description of the problem. Please be clear what parts of the problem are considered to be in-scope and out-of-scope. + +_Example:_ Sometimes engine does not emit any tests. Seems that in such situations we can use a fuzzer. + +**Solution you'd like** + +Substitute the text with a clear and concise description of what you want to happen. + +_Example:_ We can significantly improve coverage with a smart fuzzer. We can not only feed the API under test with a corner case data but analyze the control-flows graph in order to find additional data to fuzz . + +**Alternatives you've considered** + +Substitute this text with a potential alternative to the solution. + +_Example:_ We can use more simple version of a fuzzer that just finds corner cases for primitives. + +**Context** + +Substitute this text with any other context or screenshots about the feature request here. + +_Example:_ You can execute test generation for a complex example. Stop the generation in several seconds after the start. From 473a13950e1d4ac879ea89a3a660c4247ca128d3 Mon Sep 17 00:00:00 2001 From: Denis Fokin Date: Thu, 26 May 2022 11:33:12 +0300 Subject: [PATCH 2/4] Extra space is removed --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 78f78dfb58..78216b23ba 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -17,7 +17,7 @@ _Example:_ Sometimes engine does not emit any tests. Seems that in such situatio Substitute the text with a clear and concise description of what you want to happen. -_Example:_ We can significantly improve coverage with a smart fuzzer. We can not only feed the API under test with a corner case data but analyze the control-flows graph in order to find additional data to fuzz . +_Example:_ We can significantly improve coverage with a smart fuzzer. We can not only feed the API under test with a corner case data but analyze the control-flows graph in order to find additional data to fuzz. **Alternatives you've considered** From fc37f5baf97da73d964dcdfa36fc9920397dbadd Mon Sep 17 00:00:00 2001 From: Denis Fokin Date: Thu, 26 May 2022 14:54:50 +0300 Subject: [PATCH 3/4] Follow-up after Dmitry --- .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 78216b23ba..bee6967b32 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,26 +7,32 @@ assignees: '' --- -**Please, describe the problem to be solved** +**Description** -Substitute this text with a concise description of the problem. Please be clear what parts of the problem are considered to be in-scope and out-of-scope. +_Substitute this text with a concise description of the problem. Please be clear what parts of the problem are considered to be in-scope and out-of-scope._ _Example:_ Sometimes engine does not emit any tests. Seems that in such situations we can use a fuzzer. -**Solution you'd like** +**Expected behavior** -Substitute the text with a clear and concise description of what you want to happen. +_Substitute the text with a clear and concise description of what you want to happen._ _Example:_ We can significantly improve coverage with a smart fuzzer. We can not only feed the API under test with a corner case data but analyze the control-flows graph in order to find additional data to fuzz. -**Alternatives you've considered** +**Environment** -Substitute this text with a potential alternative to the solution. +_Substitute the text with steps to set up the environment for testing of the expected behavior._ -_Example:_ We can use more simple version of a fuzzer that just finds corner cases for primitives. +_Example:_ You can execute test generation for a complex example. Stop the generation in several seconds after the start. + +**Potential alternativesd** + +_Substitute this text with a potential alternative to the solution._ + +_Example:_ We can use simpler version of a fuzzer that just finds corner cases for primitives. **Context** -Substitute this text with any other context or screenshots about the feature request here. +_Substitute this text with information that can be crucial for understanding the problem._ -_Example:_ You can execute test generation for a complex example. Stop the generation in several seconds after the start. +_Example:_ fuzzing is the process of providing invalid, unexpected, or random data to a computer program. In context of UTBot, we are going to provide the data to the API under test. From b430ec30a441810ab9718ad921bea25eef6c9684 Mon Sep 17 00:00:00 2001 From: Denis Fokin Date: Thu, 26 May 2022 15:48:59 +0300 Subject: [PATCH 4/4] Typo is fixed --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bee6967b32..c5998337e0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -25,7 +25,7 @@ _Substitute the text with steps to set up the environment for testing of the exp _Example:_ You can execute test generation for a complex example. Stop the generation in several seconds after the start. -**Potential alternativesd** +**Potential alternatives** _Substitute this text with a potential alternative to the solution._