Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 12:10:03 +00:00
Code Issues Releases Activity

Update PR and issue templates.

Browse Source
This commit is contained in:
Brenden Matthews 2022-10-04 08:56:05 -05:00
parent 7fd28702b4
commit 731dd3ca04
No known key found for this signature in database
GPG Key ID: B49ABB7270D9D4FD
2 changed files with 0 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,50 +0,0 @@
**Issue**
Verify the issue you want to report is not a duplicate. If not, please explain
your bug or issue here. [DELETE ME]
**Information**
Do we require your OS and/or Conky version? If not, delete this part. Otherwise,
please report them here. [DELETE ME]
Do we require your config? If no, delete this part. Otherwise, place your
config inside `lua` triple backticks. [DELETE ME]
```lua
conky.config = {
out_to_x = false,
out_to_console = true,
};
conky.text = [[
Hello, World!
]];
```
If you want to report a crash, please try again with `gdb`.
```bash
# 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
# Backtrace.
```
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.
...
```
Please delete all descriptions, unused headers, notes, sections, etc too. Thank you.

21
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,21 +0,0 @@
**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.