docs: add FAQ and issue template (#95)

This commit is contained in:
jspc authored and GitHub committed 2022-02-04 22:53:40 +08:00
1 parent 296cbe306b
commit 8613a4e5a6
2 files changed
+50

No files matched your search

+34
View File
@@ -0,0 +1,34 @@
name: Bugs and Errors
description: File a bug report, or tell us about another error
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to open this issue.
Before submitting, please ensure you're using go 1.16.x. Please see [the FAQ](/FAQ.md) for more information.
- type: textarea
id: what-happened
attributes:
label: Describe your bug or error
description: |
What happened? What did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: input
id: version
attributes:
label: Go Version
description: What is the output of `go version`?
placeholder: go version go1.....
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
+16
View File
@@ -0,0 +1,16 @@
# Frequently Asked Questions
## General Questions
### What version of go does this project require?
This project requires anything within the `go 1.16.x` range of versions. Anything newer simply wont work, see: [issue 92](https://github.com/icexin/eggos/issues/92)
### Does this mean I have to downgrade go?
Nope. You can install [multiple versions](https://go.dev/doc/manage-install#installing-multiple) of go, which can be used with `egg` as per:
```bash
$ GOROOT=$(go1.16.13 env GOROOT) egg build
```