From 4e92acf792e9c307e365ee7a866d0d111f07dcd0 Mon Sep 17 00:00:00 2001 From: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:07:14 -0700 Subject: [PATCH] Edit issue templates (#140) * Update issue template * Update readme * Update README.md --- .github/ISSUE_TEMPLATE/bug-report.md | 26 ----------------------- .github/ISSUE_TEMPLATE/do-not-use.md | 11 ++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 21 ------------------ README.md | 5 +++-- 4 files changed, 14 insertions(+), 49 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/do-not-use.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 40e09e27..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug Report -about: Report a problem using F´ -title: '' -labels: bug -assignees: '' - ---- -| | | -|:---|:---| -|**_F´ Version_**| | -|**_Affected Component_**| | ---- -## Problem Description - -A description of the problem with sufficient detail to understand the issue. - -## How to Reproduce - -1. -2. -3. - -## Expected Behavior - -A description of the expected behavior. diff --git a/.github/ISSUE_TEMPLATE/do-not-use.md b/.github/ISSUE_TEMPLATE/do-not-use.md new file mode 100644 index 00000000..bea7e220 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/do-not-use.md @@ -0,0 +1,11 @@ +--- +name: Do not use +about: Please use https://github.com/nasa/fprime/issues instead +title: '' +labels: bug +assignees: '' + +--- +# Do not use + +Please do not use this form. Issues should be posted to https://github.com/nasa/fprime/issues/new/choose diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index e431666d..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature Request -about: Suggest improvements to F´ -title: '' -labels: enhancement -assignees: '' - ---- - -| | | -|:---|:---| -|**_F´ Version_**| | -|**_Affected Component_**| | ---- -## Feature Description - -A quick description of the requested feature. - -## Rationale - -A rationale for why the feature should be implemented in F´. diff --git a/README.md b/README.md index 13daa866..3ff94b0b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # F´ GDS -Note: This README describes GDS internals. Refer to the [user's guide](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html) -for instructions on how to use the GDS. +**Note:** This README describes GDS internals. Refer to the [user's guide](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html) for instructions on how to use the GDS. + +Issues should be reported here: [File an issue](https://github.com/nasa/fprime/issues/new/choose) ## Overview The GDS consists of a collection of classes and tools that provide an interface for fprime