From bc706901e5e84b0bd8a27de446cd3017ceac667f Mon Sep 17 00:00:00 2001 From: Jose Fernando Lopez Fernandez Date: Sun, 1 Nov 2020 19:08:51 -0500 Subject: [PATCH 1/3] Created GitHub Bug Report Issue Template I created a GitHub issue template specifically for bug reports to help streamline the process of pinning down, replicating, verifying, and fixing user-reported issues. --- .github/ISSUE_TEMPLATE/bug.md | 44 +++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000..32bbade0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,44 @@ +--- +name: Bug Report +about: There are no bugs here. But just in case... + +--- +# Bug Report +Thank you for filing a bug report! The more information you +can give us about your development environment, toolchain, +actions leading up to the bug, or any other contextual +information, the faster we'll be able to verify and diagnose +what went wrong. + +At a minimun, please be sure to include the library version +you were working with. If you were trying to compile it from +source, please be sure to specify the compiler, compiler +version, operating system, operating system version, the +build system you used to generate the project, and whether +you were building from a source distribution or from version +control. + +If you have no idea what any or all of the above terms mean, +you are always welcome to submit a bug report anyways, but +please remember the Fundamental Theorem of Bug Report +Submissions: + + > The amount of information in a bug report is directly + proportional to its resolution speed. + +## Checklist +Please do your best to include the following items with your +bug report. + +### The Bare Minimum +Remember that this is the **minimum** required information. +More is always more helpful. + + - [ ] [libcheck](https://github.com/libcheck/check) version + - [ ] Operating system + - [ ] Compiler + +## Additional Information +Please be sure to include any additional information you +think may be helpful in helping us diagnose, understand, or +replicate the problem. From b6b3b8222d7e8d751020b6ec4ca548400e6a66e9 Mon Sep 17 00:00:00 2001 From: Jose Fernando Lopez Fernandez Date: Sun, 1 Nov 2020 19:20:03 -0500 Subject: [PATCH 2/3] Created GitHub Issues Configuration File The config.yml at the root of the .github/ISSUE_TEMPLATE directory controls the issue templates configuration for the project directory. Eventually, it would be nice to not have to accept blank issues, since having an issue template for each kind of issue helps speed up the process by allowing us to define the necessary information we need up front. While we create the issue templates, however, I'm leaving blank issues enabled. I also added the user mailing list address from the website in case someone prefers to seek the wisdom therein. --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..22c0afee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Check Library Users Mailing List + url: check-users@sourceforge.net + about: User questions are accepted and welcome! From aaf1c2416a52c533a313f71b0dc9b3ec4c6f92fc Mon Sep 17 00:00:00 2001 From: Jose Fernando Lopez Fernandez Date: Tue, 3 Nov 2020 09:36:09 -0500 Subject: [PATCH 3/3] Removed User Mailing List From the Issues Template As discussed in the pull request (#315), the user mailing list has been removed to prevent the bifurcation of the user base. It is preferable to have all user questions, feature requests, and bug reports filed here via the GitHub issues feature. Discussion: https://github.com/libcheck/check/pull/315#discussion_r515748364 --- .github/ISSUE_TEMPLATE/config.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 22c0afee..0086358d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1 @@ blank_issues_enabled: true -contact_links: - - name: Check Library Users Mailing List - url: check-users@sourceforge.net - about: User questions are accepted and welcome!