From 1545ba6a2aba003cdadcf7f424ca11be028eb462 Mon Sep 17 00:00:00 2001 From: iamishalkin Date: Mon, 3 Aug 2020 13:52:52 +0300 Subject: [PATCH 1/5] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..822dd83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Please, provide: +1. Reproducible code snippet +2. Error traceback + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment:** + - OS: [e.g. Ubuntu-16.04] + - Python version: [e.g. 3.7.3] + - Package version [e.g. 0.4.0] +Note: to get package version run `import pkg_resources; pkg_resources.get_distribution('dxfeed').version` + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..307d9a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Describe the feature and the reason for it** +What functionality you'd like to be added and why. +E.g.: Please, add pandas dataframe support to the default handler. It is the most common way to work with tables in python + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. Expected code snippets are welcome + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From f4d94cdaee3e8aba88944cb9c8d4aebc484404f3 Mon Sep 17 00:00:00 2001 From: iamishalkin Date: Mon, 3 Aug 2020 13:59:25 +0300 Subject: [PATCH 2/5] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 822dd83..ba7ab2a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -22,6 +22,7 @@ A clear and concise description of what you expected to happen. - OS: [e.g. Ubuntu-16.04] - Python version: [e.g. 3.7.3] - Package version [e.g. 0.4.0] + Note: to get package version run `import pkg_resources; pkg_resources.get_distribution('dxfeed').version` **Additional context** From ca6f5163918e7d6d279abfcc16a7483ff8dae65e Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 11:02:46 +0300 Subject: [PATCH 3/5] unexpected behavior case added --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ba7ab2a..8013e6d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,17 +11,17 @@ assignees: '' A clear and concise description of what the bug is. **To Reproduce** -Please, provide: -1. Reproducible code snippet -2. Error traceback +Please, provide reproducible code snippet + +**Behavior** +Bug case: provide error traceback, please +Unexpected behavior case: provide a clear and concise description of what you expected to happen, please. -**Expected behavior** -A clear and concise description of what you expected to happen. **Environment:** - OS: [e.g. Ubuntu-16.04] - Python version: [e.g. 3.7.3] - - Package version [e.g. 0.4.0] + - Package version: [e.g. 0.4.0] Note: to get package version run `import pkg_resources; pkg_resources.get_distribution('dxfeed').version` From 8db1b66fce9c3d86984d0329a4d1c608b969feee Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 11:04:16 +0300 Subject: [PATCH 4/5] better structure --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8013e6d..e15e319 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,14 +8,14 @@ assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. +- A clear and concise description of what the bug is. **To Reproduce** -Please, provide reproducible code snippet +- Please, provide reproducible code snippet **Behavior** -Bug case: provide error traceback, please -Unexpected behavior case: provide a clear and concise description of what you expected to happen, please. +- Bug case: provide error traceback, please +- Unexpected behavior case: provide a clear and concise description of what you expected to happen, please. **Environment:** From 5d34884fd3ab3076b9946b4b782e039a3584da86 Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 17:14:49 +0300 Subject: [PATCH 5/5] Behavior + expected behavior parts --- .github/ISSUE_TEMPLATE/bug_report.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e15e319..81be973 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,15 +8,17 @@ assignees: '' --- **Describe the bug** -- A clear and concise description of what the bug is. + - A clear and concise description of what the bug is. **To Reproduce** -- Please, provide reproducible code snippet + - Provide reproducible code snippet, please. **Behavior** -- Bug case: provide error traceback, please -- Unexpected behavior case: provide a clear and concise description of what you expected to happen, please. + - Bug case: provide error traceback, please. + - Unexpected behavior case: describe the key points of behavior you face, please. +**Expected behavior** + - Provide a clear and concise description of what you expected to happen, please. **Environment:** - OS: [e.g. Ubuntu-16.04]