Small bug descriptions

[kasikci]

Folks, in each bug directory, can you also have a small description of what the bug is about? It is also useful to document the location of the root cause and the location of the failure.

[yongweiy]

Sorry, I didn't saw this issue until last night. (I received an email last time)
Actually, for most bugs, I always include a brief description of the bug at the top of its Dockerfile. But they are not formatted in a well and consistent way. I am going to add a README for each subdiretory in the following format.

[url for original issue page or ticket page]

• patch: [commit if exists else N/A]
• behavior: [segmentation fault or other error messages]
• description: [what kind of input or scenario would result in this bug]

[kasikci]

That's great. I would also document root cause and failure locations. That should help you down the way.

[yongweiy]

That makes sense. I think failure sketch could be considered as a combination of root cause and failure locations. Am I getting it right? If that is the case, so my task is to form a text version failure sketch manually (either extract information form issue page or find out myself), right?

[kasikci]

That's a great way to think about it! Exactly!

[yongweiy]

I will spend next few days working on Nginx bugs and completing bug description in an interleaving way.

[kasikci]

Great!