1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-16 01:57:09 +00:00

Add the new files, derp.

This commit is contained in:
Brenden Matthews 2022-10-04 08:56:44 -05:00
parent 731dd3ca04
commit 67e620035a
No known key found for this signature in database
GPG Key ID: B49ABB7270D9D4FD
3 changed files with 109 additions and 0 deletions

80
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,80 @@
name: 🐞 Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! If you haven't
done so already, please take a moment to search the existing issues to
see if this has been previously reported. If not, carry on.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see! Include screenshots if you have 'em.
value: "A bug happened!"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of Conky are you running?
validations:
required: true
- type: input
id: os
attributes:
label: What OS/distro are you seeing the problem on?
- type: textarea
id: config
attributes:
label: Conky config
description: Paste your Conky config here if it's relevant.
render: Lua
- type: markdown
attributes:
value: |
If you want to report a crash, please attach a stack trace.
To create one with `gdb`, try the following steps:
```shell
# Start 'conky'
$ gdb conky
# Run 'conky' with a config.
(gdb) run -c ~/.your_conky.conf
# Wait for a crash to occur, then run this.
(gdb) bt full
# ... stack trace output here ...
```
We want that backtrace inside `gdb` triple backticks.
```gdb
$ gdb conky
GNU gdb (GDB) 8.2
Copyright (C) 2018 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
...
```
- type: textarea
id: stacktrace
attributes:
label: Stacktrace
description: Paste your stacktrace here, if required.
render: Shell
- 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

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 🙏 General questions & help
url: https://github.com/brndnmtthws/conky/discussions/categories/q-a
about: Please ask and answer general questions using GitHub Discussions
- name: 💡 New ideas and feature requests
url: https://github.com/brndnmtthws/conky/discussions/categories/ideas
about: Request and discuss enhancements using GitHub Discussions

View File

@ -0,0 +1,21 @@
**Descriptions**
* Describe the changes, why they were necessary, etc
* Describe how the changes will affect existing behaviour.
* Describe how you tested and validated your changes.
* Include any relevant screenshots/evidence demonstrating that the changes work and have been tested.
**Licenses**
* Any new source files should include a GPLv3 license header.
* Any contributed code must be GPLv3 licensed.
**Notes**
* Make sure your code is clean and if you have added a new features, some
comments may be appreciated. Make sure your commit messages are
clear/information enough.
* If you added or altered settings and/or variables, make sure to
update the documentation. Do not forget to mention default values or required
build flags if this applies to your change.
* If you added a build flag, make sure to update the `static void print_version(void)` function with your new flag. If you added a new console command, make sure to update the `static void print_help(const char *prog_name)` function with your new command.
* Add tests for the code, where appropriate.
Please delete all descriptions, headers, notes, sections, etc too. Thank you.