From 0fa820669beb5d74f3f7b2dc00399b22b35d0305 Mon Sep 17 00:00:00 2001 From: olganaumenko Date: Wed, 20 Jul 2022 18:00:26 +0300 Subject: [PATCH] Naming conventions added --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a95592c8f..75e60c6720 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,33 @@ Give us some time to review your proposal and provide you with our feedback. It 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. +## 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](https://github.com/UnitTestBot/UTBotJava/blob/main/DEVNOTE.md) to setup developer environment, build and run UTBot.