From 2bda302c7839a7c9321e42f028edb4386a5a26da Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Fri, 17 Jun 2022 17:58:59 +0300 Subject: [PATCH 1/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da0791cf15..962adb6b28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,36 @@ # How to contribute to UTBot Java -## Want a new feature or change existing one? -* Create an issue with proposal and describe your idea -* Wait for our feedback, it will be decided who is preparing the pull request: we may need your help or fix on our side +To begin with, we are very thankful for your time and willingness to read this and contribute! -## Found a defect? -Ensure this defect wasn't already reported in our [Issues](https://github.com/UnitTestBot/UTBotCpp/issues) +The following guideline should help you with suggesting changes to our project, so feel free to use it for your contribution. 😃 -If not - create a new one containing: - * Environment *(describe your full setup)* - * Pre-Conditions *(some special prerequisites)* - * Steps to reproduce *(to be on the same page)* - * Actual and expected result *(what went wrong?)* -If you already have a PR with solution - link it with the created issue. +## I\`ve found a bug! How to report? + +First of all, please check our [Issues](https://github.com/UnitTestBot/UTBotJava/issues) - this bug may have already been reported, and you just don\`t need to spend your time on a new one. + +If you haven\`t found the relevant issue, don\`t hesitate to [create a new one](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=bug_report.md&title=), including as much detail as possible - the pre-made template will assist you in it. + +In case you already have a PR with solution, please remain so amazing and link it with the created issue. + + +## I have an improvement suggestion! +Want a new feature or to change the existing one? We are very welcome your fresh ideas. 😃 + +Please [create an issue](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=feature_request.md&title=) with your proposal and describe your idea with full information about it. By adding some examples you also bring much happiness to our souls! + +Give us some time to review your proposal and provide you with our feedback. It will be decided who is preparing the pull request: we may need your help or fix on our side. + + +## Coding conventions +Our team adheres to the defined requirements to coding style to optimize for readability. You can take a look on this Coding style guide to better understand what we expect to see in your code. + ## How to setup development environment? Please refer [Developer guide](DEVNOTE.md) to setup developer environment, build and run UTBot. + ## How to test you PR? Currently, not all checks are automized. It's required to do manual testing after PR. From 1274d05b8e5cc58818dfe8651dd6abcf3fbc5bbe Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Mon, 20 Jun 2022 10:16:31 +0300 Subject: [PATCH 2/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 962adb6b28..5c33d619a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Give us some time to review your proposal and provide you with our feedback. It ## Coding conventions -Our team adheres to the defined requirements to coding style to optimize for readability. You can take a look on this Coding style guide to better understand what we expect to see in your code. +Our team adheres to the defined requirements to coding style to optimize for readability. You can take a look on this [Coding style guide](https://github.com/saveourtool/diktat/blob/master/info/guide/diktat-coding-convention.md) to better understand what we expect to see in your code. ## How to setup development environment? From 7f157555855f9cd47a4e48b867a67d365b6a1ec3 Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Mon, 20 Jun 2022 10:19:39 +0300 Subject: [PATCH 3/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c33d619a6..cd82d3eb11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,9 +7,9 @@ The following guideline should help you with suggesting changes to our project, ## I\`ve found a bug! How to report? -First of all, please check our [Issues](https://github.com/UnitTestBot/UTBotJava/issues) - this bug may have already been reported, and you just don\`t need to spend your time on a new one. +First of all, please check our [Issues](https://github.com/UnitTestBot/UTBotJava/issues) — this bug may have already been reported, and you just don\`t need to spend your time on a new one. -If you haven\`t found the relevant issue, don\`t hesitate to [create a new one](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=bug_report.md&title=), including as much detail as possible - the pre-made template will assist you in it. +If you haven\`t found the relevant issue, don\`t hesitate to [create a new one](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=bug_report.md&title=), including as much detail as possible — the pre-made template will assist you in it. In case you already have a PR with solution, please remain so amazing and link it with the created issue. From 86eea07d2448ee906c1f7363f8c6cc61d050b3bb Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Mon, 20 Jun 2022 10:31:22 +0300 Subject: [PATCH 4/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd82d3eb11..d3016694d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ First of all, please check our [Issues](https://github.com/UnitTestBot/UTBotJava If you haven\`t found the relevant issue, don\`t hesitate to [create a new one](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=bug_report.md&title=), including as much detail as possible — the pre-made template will assist you in it. -In case you already have a PR with solution, please remain so amazing and link it with the created issue. +In case you already have a PR with a solution, please remain so amazing and link it with the created issue. ## I have an improvement suggestion! From c8f7bff4a3ea6c4a80d208f679e9490c6447f56e Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Wed, 22 Jun 2022 17:13:03 +0300 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3016694d7..653c8da93f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ Our team adheres to the defined requirements to coding style to optimize for rea ## How to setup development environment? -Please refer [Developer guide](DEVNOTE.md) to setup developer environment, build and run UTBot. +Please refer [Developer guide](https://github.com/UnitTestBot/UTBotJava/blob/main/DEVNOTE.md) to setup developer environment, build and run UTBot. ## How to test you PR? From 8d51b600259c08abdfb642d37715f801b179320b Mon Sep 17 00:00:00 2001 From: JaneEugenia <106974353+JaneEugenia@users.noreply.github.com> Date: Wed, 22 Jun 2022 17:41:49 +0300 Subject: [PATCH 6/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 653c8da93f..2a95592c8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Want a new feature or to change the existing one? We are very welcome your fresh Please [create an issue](https://github.com/UnitTestBot/UTBotJava/issues/new?assignees=&labels=&template=feature_request.md&title=) with your proposal and describe your idea with full information about it. By adding some examples you also bring much happiness to our souls! -Give us some time to review your proposal and provide you with our feedback. It will be decided who is preparing the pull request: we may need your help or fix on our side. +Give us some time to review your proposal and provide you with our feedback. It will be decided who is preparing the pull request: we may need your help or we will take care of it all. 🙂 ## Coding conventions