develooper Front page | perl.perl5.porters | Postings from March 2023

Re: perlbug UX

Thread Previous | Thread Next
From:
Craig A. Berry
Date:
March 2, 2023 20:12
Subject:
Re: perlbug UX
Message ID:
CA+vYcVxv77gOMdeoPNESdGfeqbUZK-E_N+1=yKDDawyVOFoFkQ@mail.gmail.com
On Thu, Mar 2, 2023 at 1:43 AM Zefram via perl5-porters
<perl5-porters@perl.org> wrote:

> I did make recommendations, but to be fair they were buried in a lngthy
> message.  I propose that the perlbug template should state, in the
> to-be-user-edited portion, what relationship the user input is expected
> to bear to the markup language, and should point at a specification for
> that markup language.  I also propose that, if the body of the perlbug
> output is expected to be a marked-up document, then the headers of the
> perlbug output should include the appropriate MIME bits saying so.

That sounds reasonable. Looks like text/markdown is the appropriate type:

https://www.rfc-editor.org/rfc/rfc7763.html

BUT, it looks like charset is required to go with it -- do we know
what that is?  Once upon a time we were trying to figure out how to
determine the character set of the report but I'm not sure that ever
got solved.

We could also say variant=GFM (for GitHub-Flavored Markdown) to
indicate the variant we are using:

https://www.iana.org/assignments/markdown-variants/GFM

It's not a specification, but basic instructions for writing Markdown
for GitHub are here:

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About