Skip to content

Commit d273445

Browse files
committed
CONTRIBUTING.md: metion test pattern for bug reports
1 parent b972f77 commit d273445

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,24 @@ Please follow these rules when reporting the issue:
5151
1. compilation options
5252
1. GPUJPEG parameters
5353
1. console output of the library/application
54-
1. image for which the problem occurs
54+
1. image for which the problem occurs (test pattern can be used, see below)
5555

5656
Also please look into [FAQ.md](FAQ.md) to see if the the issue isn't already solved.
5757

58+
### Test image pattern
59+
60+
_gpujpegtool_ application (in API implemented through
61+
`gpujpeg_image_load_from_file()`) has capability to generate testing
62+
input. If applicable, it is advised to report bugs against that
63+
pattern (point 6 above). Usage is eg.:
64+
```
65+
gpujpegtool -e 1920x1080.tst out.jpg # generates Full-HD RGB image gradient
66+
gpujpegtool -e help.tst out.jpg # to show usage (out.jpg not written)
67+
```
68+
69+
Different patterns and/or properties like pixel format or color-space avaiable.
70+
71+
5872
Development
5973
-----------
6074
Contributing by your own code is definitely highly appreciated. There

0 commit comments

Comments
 (0)