From 5c002d62c1787f7df7feaf6f3161f222224d0f3a Mon Sep 17 00:00:00 2001 From: qchempku2017 Date: Wed, 4 Oct 2023 12:06:17 -0700 Subject: [PATCH] DOC: remove the issue templates to use the standard format of CederGroupHub. --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ------------------ .github/ISSUE_TEMPLATE/code_review.md | 49 ----------------------- .github/ISSUE_TEMPLATE/feature_request.md | 21 ---------- 3 files changed, 109 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/code_review.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 83214b2..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: "\U0001F41B Bug Report" -about: "If something isn't working as expected \U0001F914." -labels: bug - ---- - - - - - -## Expected Behavior - - -## Current Behavior - - -## Possible Solution - - -## Steps to Reproduce - - -1. -2. - -## Context - - - - - -## Detailed Description - - -## Possible Implementation - diff --git a/.github/ISSUE_TEMPLATE/code_review.md b/.github/ISSUE_TEMPLATE/code_review.md deleted file mode 100644 index 04e3c22..0000000 --- a/.github/ISSUE_TEMPLATE/code_review.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: "\U00002615 Code Review" -about: "Use this template for code review & commentary of a specific source file. \U0001F60E" -title: "[Code Review] latte.py (edit this)" -labels: code review -assignees: lbluque, qchempku2017 - ---- - - - -| File Name | Module Path | Authors| -|-----------|----------------|--------| -| latte.py | WFacer.oatmilk |Mr. Coder| - -## Code Review -We use *code review* issues to open up a pinned location to discuss a specific -source file. - -### Source file summary -Please add a brief summary of what the purpose of the code in the source file -is. (A good and short docstring can be just copy and pasted.) - -#### Use github features when possible please! - -**Point to specific lines in code** - -If you are mentioning a set of specific lines in code already implemented, it -may come in handy to add a -[permanent link](https://docs.github.com/en/enterprise/2.21/user/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet) to it. - -**Format suggested code nicely** - -```python -def roast(beans, *flavoring_oils): - for oil in flavoring_oils: - beans.add_oil(oils) - return np.trapz(beans.get_heat_vector()) -``` - -**Use other handy features too** - -Using many of other handy features offered, can help improve discussion. -https://docs.github.com/en diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6afe67f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Suggest an idea for this project -labels: enhancement - ---- - - - -**Is your feature request related to a problem? Please describe.** -Please describe the problem you are trying to solve. - -**Describe the solution you'd like** -Please describe the desired behavior. - -**Describe alternatives you've considered** -Please describe alternative solutions or features you have considered.