From 23229a881b0904e53629101dc788efc48d3c94f8 Mon Sep 17 00:00:00 2001 From: Sebastian Funk Date: Mon, 19 Feb 2024 20:02:25 +0000 Subject: [PATCH] hotfix: small improvements to issue/PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/documentation.md | 6 ++++-- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++-- .github/ISSUE_TEMPLATE/other_issue.md | 5 ++++- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++------ 6 files changed, 25 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4fb5c22be..c051228cb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,16 +1,16 @@ --- name: Bug report about: | - *Bugs* manifest in issue when using the package but may also include behaviour - that does not impact package functionality, but which seems as though it might - not be intended by the package developers. + Bugs could be unexpected error messages, flawed results and behaviour that does not seem as + intended by the package developers. title: '' labels: '' assignees: '' --- + for providing more detail where appropriate +--> Summary: Please provide a short summary (no more than a sentence or two). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 26fb2acc9..e874b8f6f 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -8,8 +8,10 @@ labels: '' assignees: '' --- - + Type of issue: State whether you are commenting on existing documentation / vignettes, or suggesting a new vignette. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c9ae5ede2..dcd989f47 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,8 +6,10 @@ labels: '' assignees: '' --- - + Is your feature request related to a problem? Please describe: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md index 1a1b4c3ac..e1089fd16 100644 --- a/.github/ISSUE_TEMPLATE/other_issue.md +++ b/.github/ISSUE_TEMPLATE/other_issue.md @@ -6,5 +6,8 @@ labels: '' assignees: '' --- -Please include a brief description of the issue and any proposed solutions you may have. + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e933ca158..fd8fd2ab6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,12 @@ - + + If this is your first Pull Request, please make sure you read the + contributing guidelines linked below and at + https://github.com/epiforecasts/EpiNow2/blob/main/.github/CONTRIBUTING.md +--> ## Description