Skip to content

Commit 3b27deb

Browse files
authored
pull_request_template tell about rules (#580)
improve pull request template - add info regarding processes - add example regarding typo/spelling/grammar fix. --------- Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 0cb0fcc commit 3b27deb

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22
Thank you for taking the time to develop and contribute a core enhancement or fix for a defect!
33
44
We kindly request that you create pull requests only for things that have been discussed in a ticket first; exceptions may be made for spelling or grammar fixe.
5+
Read more about the process here: https://cyclonedx.org/participate/standardization-process/#working-model
6+
57
Please have the related ticket/issue ID ready.
68
If there is none, feel free to create a new ticket: https://github.com/CycloneDX/specification/issues/new/choose
9+
710
-->
811

912
<!--
1013
11-
Please provide a brief description of what this pull request intends to do and which ticket it fixes/closes.
12-
14+
Please provide a brief description of what this pull request intends to do and which ticket it fixes/closes.
1315
Example:
14-
> As discussed in ticket #485, this PR adds Streebog to the hash algorithm enum.
15-
>
16+
> As discussed in ticket #485, this PR adds Streebog to the hash algorithm enum.
17+
>
1618
> fixes #485
1719
20+
In case this is for a spelling or grammar improvement, please provide a brief description.
21+
Example:
22+
> Fixe typo: color(AE) -> colour(BE)
23+
1824
-->

0 commit comments

Comments
 (0)