Skip to content

Commit

Permalink
docs: add build.md issue template
Browse files Browse the repository at this point in the history
Based on .github/ISSUE_TEMPLATE/bug_report.md.
  • Loading branch information
kmk3 committed Jul 26, 2024
1 parent 4ad26b3 commit e317dfc
Showing 1 changed file with 86 additions and 0 deletions.
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
name: Build issue
about: There is an issue when trying to build the project from source
title: 'build: '
labels: ''
assignees: ''

---

<!--
See the following links for help with formatting:
https://guides.github.com/features/mastering-markdown/
https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
-->

### Description

_Describe the bug_

### Steps to Reproduce

<!--
Note: If the output is too long to embed it into the comment, you can post it
in a gist at <https://gist.github.com/> and link it here or upload the build
log as a file.
Note: Make sure to include the exact command-line used for all commands and to
include the full output of ./configure.
Feel free to include only the errors in the make output if they are
self-explanatory (for example, with `make >/dev/null`).
-->

_Post the commands used to reproduce the issue and their output_

Example:

<details>
<summary>Build output</summary>
<p>

```console
$ ./configure --enable-apparmor
checking for gcc... gcc
checking whether the C compiler works... yes
[...]
$ make
make -C src/lib
gcc [...]
[...]
```

</p>
</details>

_If ./configure fails, include the output of config.log_

Example:

<details>
<summary>config.log</summary>
<p>

```console
$ cat config.log
This file contains any messages produced by compilers while
running configure, to aid debugging if configure makes a mistake.
[...]
```

</p>
</details>

### Additional context

_(Optional) Any other detail that may help to understand/debug the problem_

### Environment

- Name/version/arch of the Linux kernel (e.g. the output of `uname -srm`)
- Name/version of the Linux distribution (e.g. "Ubuntu 20.04" or "Arch Linux")
- Name/version of the C compiler (e.g. "gcc 14.1.0")
- Name/version of the libc (e.g. "glibc 2.39-1")
- Version of the Linux API headers (e.g. "linux-api-headers 6.8-1" on Arch Linux)
- Version of the source code being built (e.g. the output of `git rev-parse HEAD`)

0 comments on commit e317dfc

Please sign in to comment.