Skip to content

Commit 3ebeb1a

Browse files
authored
Contribution guidelines for PR generation with service related commit message Headers (#565)
for raising PR with service name prefixed such as [JIRA] or [CONFLUENCE] identifying which service fix Help the reviewer and log viewers to associate the feature is for which service
1 parent 4461ff4 commit 3ebeb1a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,29 @@ Mandatory conditions
3232

3333
Please follow the code style in the docs.
3434

35+
36+
Before you raise a PR
37+
---------------------
38+
39+
Create the **Commit Header** with the relevant Service Name pre-fixed, examples below,
40+
41+
* Jira: review user module :heavy_check_mark:
42+
* [JIRA] Issues Move to Sprint :heavy_check_mark:
43+
* Confluence: update_page_property method :heavy_check_mark:
44+
45+
An example of a commit message header,
46+
47+
* Addition of parameters for start & limit in the function of `get_all_project_issues` :x:
48+
49+
could be better written as,
50+
51+
* [JIRA] Project Issues parameter addition for start and limit :heavy_check_mark:
52+
53+
with the commit body have a detail about where/what changes introduced.
54+
55+
This will help the reviewer or log-viewers to better identify what a particular commit is for.
56+
57+
3558
Using your changes before they’re live
3659
--------------------------------------
3760

0 commit comments

Comments
 (0)