To ensure that your issues get the attention they require—and quickly—we need you to meet us half-way, otherwise, your post may be unlisted by a moderator or left unresponded to.
How? By following the guidelines laid out below.
Why? There are thousands of you and only a handful of us—all volunteers with busy lives. You stand the best chance of attracting good answers if your issue is well-formulated and well-researched. Better yet, you might end up resolving it by yourself!
Always search for your issue before posting, in case we’ve already discussed, resolved, or written a guide for it:
Search our Github issue tracker (remember to search our pull requests too),
If you can identify the package responsible for your issue, check their issue tracker. Use
M-x doom/help-package-homepageto open their project page in your browser, straight from Emacs.
If you’re here about a bug, misbehavior, or errors, then some debugging is in order. This can reveal information about your issue that we will ask for anyway—or possibly enable you to resolve it yourself:
$ doom clean && doom build && doom sync -u(this may take a while), then restart Emacs. Did that fix the issue?
$ doom doctor– this will report common issues with your system and config.
Can you reproduce the issue on the latest commit of Doom Emacs? (Run
$ doom upgradeto properly update it)
Can you reproduce the issue in vanilla Doom?
Consult our debugging guide.
For general user support, post in one of #support’s sub-categories:
#support:cli – For issues that arise while using the
- #support:upstream – For issues originating upstream (e.g. plugins, Emacs, the OS, etc).
- #support:themes – For questions concerning writing or customizing themes and faces.
- #support:code – To ask for code reviews and about Emacs Lisp.
- #support:org – For user support with Org and Org plugins.
- #support:perf – For issues concerning startup or runtime performance.
- #support:nondoom – for issues concerning non-Doom Emacs configs (e.g. vanilla, Spacemacs, etc).
- #support:website – for issues using doomemacs.org.
- Not sure where your issue belongs? Post it directly in #support.
- #support:cli – For issues that arise while using the
For feature requests or development questions, post in #dev.
Need help using our Discourse, Discord, or Github? Post in #meta.
Now to create the topic!
To open the composer, click on the top-right of any category page
Assign your topic one of the following tags:
- #issue — for help with bugs and unintended behavior
- #request — to request changes or new features
- #question — general support (e.g. how-to questions)
- #notice — an FYI to the community and project maintainer
- #guide — an extensive tutorial for other users
- #tip — a quick and brief protip for other users
- #discussion — a request to talk, exchange ideas, or survey others
- #project — a post that keeps track of some ongoing development effort
Pay careful attention to the pre-filled template and fill it in.
Then click and you’re good to go!
When is it more appropriate to create a Github issue instead?
When you are reasonably certain that an issue is caused by Doom, and not by private configuration or a third party package. When in doubt, post in #support (or on our Discord). A maintainer will create a Github issue for it once confirmed.
My issue hasn’t gotten a response yet. What do I do?
Discourse will automatically bump old, unanswered posts, so all you have to do is wait, but after three months posts are automatically closed (and later moved to #archive, if no solution was found/proposed). If you get no response after a couple days, you may have better luck asking another community:
- Emacs on IRC
- Emacs mailing lists
However, if you find your answer elsewhere, we’d appreciate if you’d let us know, so we can archive the solution here for future users.
Please don’t rant at us, give us ultimatums, or start your post off airing your frustrations. We get it—Emacs can be frustrating—but we’re (volunteer) problem solvers, not therapists. ↩︎
- Avoid phrases like “it doesn’t work” or “X stopped working”. These are ambiguous.
- If you mention keybinds, also mention what commands they’re bound to.
- If you’re comparing to another Emacs distro or editor, please link to more information about their features, or include a screencast of it, to help us understand it better.
- Please include a list of steps to reproduce your issue.
Click this button beneath the post responsible.
If no post qualifies, reply to yourself and mark that instead. ↩︎