From bebe8d3bace4b819e26cde11de868064327412c7 Mon Sep 17 00:00:00 2001 From: Xan Johnson Date: Thu, 17 Jun 2021 09:08:23 -0600 Subject: [PATCH 1/2] Added pull request template Signed-off-by: Xan Johnson --- .../{ISSUE_TEMPLATE => }/ISSUE_TEMPLATE.md | 2 +- .github/pull_request_template.md | 35 +++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) rename .github/{ISSUE_TEMPLATE => }/ISSUE_TEMPLATE.md (92%) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 92% rename from .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md index 20f930c..5b6e9cb 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ --- name: Generic Issue Template -about: A standard issue template to use in all Symbiflow repositories. +about: A standard issue template to use in all Symbiflow repositories. Adapted from [*Open Source Templates*](https://www.talater.com/open-source-templates/#/) by Tal Ater. --- diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d021581 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +--- +name: Pull request template +about: A standard pull request template to use for all Symbiflow repositories. Adapted from [*Open Source Templates*](https://www.talater.com/open-source-templates/#/) by Tal Ater. +--- + + +## Description + + +## Motivation and Context + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. From b4edf34644b6b26ff50fcb1c311a5dbfe6300a78 Mon Sep 17 00:00:00 2001 From: Xan Johnson Date: Mon, 21 Jun 2021 11:34:28 -0600 Subject: [PATCH 2/2] Added two different Issue Templates Updated .editorconfig Signed-off-by: Xan Johnson --- .editorconfig | 18 ++++++--- .github/ISSUE_TEMPLATE.md | 37 ------------------ .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-BUG.md | 38 +++++++++++++++++++ .../ISSUE_TEMPLATE/ISSUE_TEMPLATE-FEATURE.md | 24 ++++++++++++ 4 files changed, 75 insertions(+), 42 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-BUG.md create mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-FEATURE.md diff --git a/.editorconfig b/.editorconfig index 8e77927..dd1bf85 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,19 +1,27 @@ # Editor config file, see http://editorconfig.org/ root = true -#are there any other file formats that requrie tabs? [*] charset = utf-8 indent_style = space -end_of_line = lf #verified v/sv +end_of_line = lf insert_final_newline = true -trim_trailing_whitespace = true #validated c +trim_trailing_whitespace = true -[*.{h,cpp,tcl,v,sv,html}] -indent_size = 2 #validated +[{*.{h,cpp,cc,tcl,v,sv,html,sh,cmake},CMakeLists.txt}] +indent_size = 2 [*.py] indent_size = 4 [Makefile] indent_style = tab + +# Ignore third_party directory +[/third_party/**] +charset = unset +indent_style = unset +end_of_line = unset +insert_final_newline = unset +trim_trailing_whitespace = unset +indent_size = unset diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 5b6e9cb..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Generic Issue Template -about: A standard issue template to use in all Symbiflow repositories. Adapted from [*Open Source Templates*](https://www.talater.com/open-source-templates/#/) by Tal Ater. ---- - - -## Expected Behavior - - - -## Current Behavior - - - -## Possible Solution - - - -## Steps to Reproduce (for bugs) - - -1. -2. -3. -4. - -## Context - - - -## Your Environment - -* Version used: -* Environment name and version (e.g. Chrome 39, node.js 5.4): -* Operating System and version (desktop or mobile): -* Link to your project: - diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-BUG.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-BUG.md new file mode 100644 index 0000000..d63a7df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-BUG.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +title: Bug Report +about: A standard issue template to use in all Symbiflow repositories. Adapted from Open Source Templates by Tal Ater. +labels: bug +--- + + +## Description + + +## Expected Behavior + + +## Actual Behavior + + +## Possible Fix + + +## Steps to Reproduce + + +1. +2. +3. +4. + +## Context + + +## Your Environment + +* Version used: +* Environment name and version (e.g. Chrome 39, node.js 5.4): +* Operating System and version (desktop or mobile): +* Link to your project: + diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-FEATURE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-FEATURE.md new file mode 100644 index 0000000..fb6e82c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE-FEATURE.md @@ -0,0 +1,24 @@ +--- +name: New Feature/Improvement +about: A standard issue template to use in all Symbiflow repositories. Adapted from Open Source Templates by Tal Ater. +labels: enhancement +--- + + +## Detailed Description + + +## Context + + + +## Possible Implementation + + +## Your Environment + +* Version used: +* Environment name and version (e.g. Chrome 39, node.js 5.4): +* Operating System and version (desktop or mobile): +* Link to your project: +