From: Ihor Radchenko <email@example.com> To: firstname.lastname@example.org Cc: Michael Heerdegen <email@example.com>, firstname.lastname@example.org Subject: [FWD from emacs-orgmode] Re: Bug: About org-submit-bug-report [9.3 (release_9.3 @ /usr/local/share/emacs/27.0.50/lisp/org/)] Date: Fri, 20 Dec 2019 17:18:33 +0800 [thread overview] Message-ID: <email@example.com> (raw) In-Reply-To: <firstname.lastname@example.org> [Forwarding this to emacs-devel] The naming convention for mode-specific bug reporting seems to be confusing. The bug reporting functions are often not easy to discover without knowing the explicit command name (especially with emacs default completion interface). For example see recent message in emacs-orgmode (below). > I want to suggest to make `report-org-bug' and alias for the command > `org-submit-bug-report'. That's the name I expected (considering > "report-emacs-bug"), also some other Emacs packages name their bug > reporting command according to this scheme. The additional name would > make this important command more discoverable. Another convention for bug report command is *mode*-report-bug/*mode*-bug-report: calc-report-bug reftex-report-bug eshell-report-bug gnuplot-bug-report c-submit-bug-report Though several modes are also using the naming similar to org-submit-bug-report: c-submit-bug-report diredp-send-bug-report org-edna-submit-bug-report I am thinking if it would make sense to develop more standardised command name conventions for bug reporting and add them to (elisp)Emacs Lisp:Preparing Lisp code for distribution Then, the built-in emacs packages might be changed to follow those conventions and improve discoverability of bug reporting capabilities. Also, an information that different major modes may have they own bug reporting tools might be mentioned in the default template shown in report-emacs-bug. What do you think? Regards, Ihor Michael Heerdegen <email@example.com> writes: > Hello, > > I want to suggest to make `report-org-bug' and alias for the command > `org-submit-bug-report'. That's the name I expected (considering > "report-emacs-bug"), also some other Emacs packages name their bug > reporting command according to this scheme. The additional name would > make this important command more discoverable. > > Second point: When you think it is a trivial task for a common user > please consider to add some text to the initial buffer contents of the > message buffer created by this command explaining where one can search > for existing reports (to avoid duplicates and reports about things that > are just pitfalls etc). My buffer included a link to a page explaining > how to create a good report but there this information is also missing, > although I think it would be a good place. > > TIA, > > Michael. > > Emacs : GNU Emacs 27.0.50 (build 41, x86_64-pc-linux-gnu, GTK+ Version 3.24.13) > of 2019-12-20 > Package: Org mode version 9.3 (release_9.3 @ /usr/local/share/emacs/27.0.50/lisp/org/) >
next prev parent reply other threads:[~2019-12-20 9:18 UTC|newest] Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-12-20 0:36 Michael Heerdegen 2019-12-20 9:18 ` Ihor Radchenko [this message] 2020-02-03 19:21 ` Bastien
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://www.orgmode.org/ * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --subject='[FWD from emacs-orgmode] Re: Bug: About org-submit-bug-report [9.3 (release_9.3 @ /usr/local/share/emacs/27.0.50/lisp/org/)]' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://git.savannah.gnu.org/cgit/emacs/org-mode.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).