Skip to content

Commit 864adb6

Browse files
olganaumenkoolganaumenko
authored andcommitted
Naming conventions added
1 parent 90cac71 commit 864adb6

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,33 @@ Give us some time to review your proposal and provide you with our feedback. It
2626
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.
2727

2828

29+
## Naming conventions
30+
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 🙂
31+
32+
Our favorite recipes are:
33+
34+
**issue title = feature request or bug description + issue ID**
35+
36+
**commit message = PR title = fix description + issue ID + (PR number)**
37+
38+
How to insert the issue ID into the commit message and the PR title?<br>
39+
— Manually.
40+
41+
How to append the PR number to the PR title?<br>
42+
— It appends automatically.
43+
44+
How to insert the PR number into the commit message?<br>
45+
*Push* the feature branch + *Create pull request* on GitHub and then →<br>
46+
1) The preferred and the easiest flow:
47+
<br>*Squash and merge* on GitHub → the PR number automatically appends to the resulting commit message
48+
2) The flow for advanced users:
49+
<br>(a) squash the commits locally → insert the PR number in parentheses (!) manually into the resulting commit
50+
message + *Force Push* the resulting commit → *Rebase and merge* on GitHub
51+
<br>or
52+
<br>(b) change the commit message locally → insert the PR number in parentheses (!) manually + *Force Push* the
53+
commit → *Rebase and merge* on GitHub
54+
55+
2956
## How to setup development environment?
3057

3158
Please refer [Developer guide](https://github.com/UnitTestBot/UTBotJava/blob/main/DEVNOTE.md) to setup developer environment, build and run UTBot.

0 commit comments

Comments
 (0)