Add issue/pr templates
This commit is contained in:
parent
8ad2666f8f
commit
b0e6ba769e
2 changed files with 44 additions and 0 deletions
39
.github/ISSUE_TEMPLATE
vendored
Normal file
39
.github/ISSUE_TEMPLATE
vendored
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
Here are some things you should try before filing a bug report:
|
||||||
|
|
||||||
|
+ Run `make install` to ensure all plugins are installed.
|
||||||
|
+ `void-function` or `void-variable` errors could signal an out-of-date autoloads file. Run `make autoloads` or `M-x doom//reload-autoloads` to update it.
|
||||||
|
+ Scan for common OS/environment issues with `make doctor`.
|
||||||
|
+ Never debug byte-compiled code. It will interfere in subtle ways. Clean up \*.elc files with `make clean` or `M-x doom//clean-byte-compiled-files`.
|
||||||
|
+ Check [the FAQ](https://github.com/hlissner/doom-emacs/wiki/FAQ#troubleshooting) to see if your issue is mentioned.
|
||||||
|
+ Check the relevant module's README.org, if one exists. There may be extra steps to getting certain features to work.
|
||||||
|
|
||||||
|
If none of those help, remove this section and fill out the four sections in the template below.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Observed behavior
|
||||||
|
|
||||||
|
Describe what happened. Any aids you can include (that you think could be relevant) are a tremendous help; like a screencast gif, video, or link to your customizations for Doom (e.g. a repo or a pastebin).
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
|
||||||
|
Describe what you _expected_ to happen.
|
||||||
|
|
||||||
|
### Steps to reproduce
|
||||||
|
|
||||||
|
1. Select these example steps,
|
||||||
|
2. Delete them,
|
||||||
|
3. And replace them with precise steps to reproduce your issue.
|
||||||
|
|
||||||
|
### System information
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to expand</summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
Replace this line with the output of *one* of these commands:
|
||||||
|
|
||||||
|
+ `M-x doom/info` (from inside Emacs)
|
||||||
|
+ `DEBUG=1 make doctor` (command line)
|
||||||
|
```
|
||||||
|
</details>
|
5
.github/PULL_REQUEST_TEMPLATE
vendored
Normal file
5
.github/PULL_REQUEST_TEMPLATE
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
Thank you for contributing to Doom!
|
||||||
|
|
||||||
|
Before you submit this PR, please make sure your PR is targeted at develop, not
|
||||||
|
master (unless this is a fix for a critical error). Then replace this message
|
||||||
|
with a description of your changes.
|
Loading…
Add table
Add a link
Reference in a new issue