|
1 | 1 | # How to contribute to UTBot Java |
2 | 2 |
|
3 | | -## Want a new feature or change existing one? |
4 | | -* Create an issue with proposal and describe your idea |
5 | | -* Wait for our feedback, it will be decided who is preparing the pull request: we may need your help or fix on our side |
| 3 | +To begin with, we are very thankful for your time and willingness to read this and contribute! |
6 | 4 |
|
7 | | -## Found a defect? |
8 | | -Ensure this defect wasn't already reported in our [Issues](https://github.com/UnitTestBot/UTBotCpp/issues) |
| 5 | +The following guideline should help you with suggesting changes to our project, so feel free to use it for your contribution. 😃 |
9 | 6 |
|
10 | | -If not - create a new one containing: |
11 | | - * Environment *(describe your full setup)* |
12 | | - * Pre-Conditions *(some special prerequisites)* |
13 | | - * Steps to reproduce *(to be on the same page)* |
14 | | - * Actual and expected result *(what went wrong?)* |
15 | 7 |
|
16 | | -If you already have a PR with solution - link it with the created issue. |
| 8 | +## I\`ve found a bug! How to report? |
| 9 | + |
| 10 | +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. |
| 11 | + |
| 12 | +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. |
| 13 | + |
| 14 | +In case you already have a PR with a solution, please remain so amazing and link it with the created issue. |
| 15 | + |
| 16 | + |
| 17 | +## I have an improvement suggestion! |
| 18 | +Want a new feature or to change the existing one? We are very welcome your fresh ideas. 😃 |
| 19 | + |
| 20 | +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! |
| 21 | + |
| 22 | +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. 🙂 |
| 23 | + |
| 24 | + |
| 25 | +## Coding conventions |
| 26 | +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. |
| 27 | + |
17 | 28 |
|
18 | 29 | ## How to setup development environment? |
19 | 30 |
|
20 | | -Please refer [Developer guide](DEVNOTE.md) to setup developer environment, build and run UTBot. |
| 31 | +Please refer [Developer guide](https://github.com/UnitTestBot/UTBotJava/blob/main/DEVNOTE.md) to setup developer environment, build and run UTBot. |
| 32 | + |
21 | 33 |
|
22 | 34 | ## How to test you PR? |
23 | 35 |
|
|
0 commit comments