From 60f67df286da9c4b00c80d22baa5dfaa4f3d8426 Mon Sep 17 00:00:00 2001 From: Peter Kosztolanyi Date: Tue, 22 Sep 2020 13:54:21 +0100 Subject: [PATCH] Github templates (#38) --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 20 ++++++++++++ .github/ISSUE_TEMPLATE/QUESTION.md | 10 ++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/PULL_REQUEST_TEMPLATE.md | 32 +++++++++++++++++++ 5 files changed, 106 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..8fdf910 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Prepare the data as '...' +2. Run the command '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Your environment** + - Version of tap: [e.g. 2.0.0] + - Version of python [e.g. 3.8] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 0000000..6532412 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 0000000..c6b98dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,10 @@ +--- +name: Question +about: Ask anything about this project +title: '' +labels: help wanted +assignees: '' + +--- + +**Your question** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8ee97ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: PipelineWise Community Slack channel + url: https://singer-io.slack.com/messages/pipelinewise + about: Open discussion about PipelineWise \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1bb4c74 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +## Problem + +_Describe the problem your PR is trying to solve_ + +## Proposed changes + +_Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. +If it fixes a bug or resolves a feature request, be sure to link to that issue._ + + +## Types of changes + +What types of changes does your code introduce to PipelineWise? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (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 not work as expected) +- [ ] Documentation Update (if none of the other choices apply) + + +## Checklist + +- [ ] Description above provides context of the change +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] Unit tests for changes (not needed for documentation changes) +- [ ] CI checks pass with my changes +- [ ] Bumping version in `setup.py` is an individual PR and not mixed with feature or bugfix PRs +- [ ] Commit message/PR title starts with `[AP-NNNN]` (if applicable. AP-NNNN = JIRA ID) +- [ ] Branch name starts with `AP-NNN` (if applicable. AP-NNN = JIRA ID) +- [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)" +- [ ] Relevant documentation is updated including usage instructions \ No newline at end of file