Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (36 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

63 lines (36 loc) · 3.22 KB

How to contribute to UTBot Java

To begin with, we are very thankful for your time and willingness to read this and contribute!

The following guideline should help you with suggesting changes to our project, so feel free to use it for your contribution. 😃

I`ve found a bug! How to report?

First of all, please check our 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, including as much detail as possible — the pre-made template will assist you in it.

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!

Want a new feature or to change the existing one? We are very welcome your fresh ideas. 😃

Please create an issue 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 we will take care of it all. 🙂

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.

Naming conventions

We have been using GitHub for a while, and now we have a couple of tips for naming issues, commits and pull requests (PRs). You are welcome to stick to them too 🙂

Our favorite recipes are:

issue title = feature request or bug description + issue ID

commit message = PR title = fix description + issue ID + (PR number)

How to insert the issue ID into the commit message and the PR title?
— Manually.

How to append the PR number to the PR title?
— It appends automatically.

How to insert the PR number into the commit message?
— Push the feature branch + Create pull request on GitHub and then →

  1. The preferred and the easiest flow:
    Squash and merge on GitHub → the PR number automatically appends to the resulting commit message
  2. The flow for advanced users:
    (a) squash the commits locally → insert the PR number in parentheses (!) manually into the resulting commit message + Force Push the resulting commit → Rebase and merge on GitHub
    or
    (b) change the commit message locally → insert the PR number in parentheses (!) manually + Force Push the commit → Rebase and merge on GitHub

How to setup development environment?

Please refer Developer guide 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.