diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..89395fb3d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,47 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +A clear and concise description of what the bug is. + +### Expected results + +what you expected to happen. + +### Actual results + +what actually happens. + +#### Screenshots + +If applicable, add screenshots to help explain your problem. + +#### How to reproduce the bug + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Environment + +(please complete the following information): + +- superset version: [e.g. `v0.29`, `master`, `commit`] +- python version: `python --version` +- node.js version: `node -v` +- npm version: `npm -v` + +### Checklist + +Make sure these boxes are checked before submitting your issue - thank you! + +- [ ] I have checked the superset logs for python stacktraces and included it here as text if there are any. +- [ ] I have reproduced the issue with at least the latest released version of superset. +- [ ] I have checked the issue tracker for the same issue and I haven't found one similar. + +### 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 0000000000..066b2d920a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**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. diff --git a/.github/ISSUE_TEMPLATE/sip.md b/.github/ISSUE_TEMPLATE/sip.md new file mode 100644 index 0000000000..4e668b3366 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sip.md @@ -0,0 +1,31 @@ +--- +name: SIP +about: Superset Improvement Proposal + +--- + +## [SIP] Proposal for XXX + +### Motivation + +Description of the problem to be solved. + +### Proposed Change + +Describe how the feature will be implemented, or the problem will be solved. If possible, include mocks, screenshots, or screencasts (even if from different tools). + +### New or Changed Public Interfaces + +Describe any new additions to the model, views or `REST` endpoints. Describe any changes to existing visualizations, dashboards and React components. Describe changes that affect the Superset CLI and how Superset is deployed. + +### New dependencies + +Describe any `npm`/`PyPI` packages that are required. Are they actively maintained? What are their licenses? + +### Migration Plan and Compatibility + +Describe any database migrations that are necessary, or updates to stored URLs. + +### Rejected Alternatives + +Describe alternative approaches that were considered and rejected. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..4240962910 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +##### SUMMARY + + +### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF + + +### TEST PLAN + + +### ADDITIONAL INFORMATION + + +- [ ] Has associated issue: +- [ ] Changes UI +- [ ] Requires DB Migration. Confirm DB Migration upgrade and downgrade tested. +- [ ] Introduces new feature or API +- [ ] Removes existing feature or API +- [ ] Fixes bug +- [ ] Refactors code +- [ ] Adds test(s) + +### REVIEWERS diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000000..835911844b --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,14 @@ +# Configuration for request-info - https://github.com/behaviorbot/request-info + +# *Required* Comment to reply with +requestInfoReplyComment: > + We would appreciate it if you could provide us with more info about this issue/pr! + +# *OPTIONAL* default titles to check against for lack of descriptiveness +# MUST BE ALL LOWERCASE +requestInfoDefaultTitles: + - update readme.md + - updates + +# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given +requestInfoLabelToAdd: "need:more-info" diff --git a/.github/move.yml b/.github/move.yml new file mode 100644 index 0000000000..3c4320b5cd --- /dev/null +++ b/.github/move.yml @@ -0,0 +1,27 @@ +# Configuration for Move Issues - https://github.com/dessant/move-issues + +# Delete the command comment when it contains no other content +deleteCommand: true + +# Close the source issue after moving +closeSourceIssue: true + +# Lock the source issue after moving +lockSourceIssue: false + +# Mention issue and comment authors +mentionAuthors: true + +# Preserve mentions in the issue content +keepContentMentions: false + +# Move labels that also exist on the target repository +moveLabels: true + +# Set custom aliases for targets +# aliases: +# r: repo +# or: owner/repo + +# Repository to extend settings from +# _extends: repo diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 0000000000..b6b56de6f7 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,18 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 60 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 7 +# Issues with these labels will never be considered stale +exemptLabels: + - "SIP" + - ".pinned" + - ".security" +# Label to use when marking an issue as stale +staleLabel: inactive +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: false diff --git a/.rat-excludes b/.rat-excludes index fd95ec0afe..61d68b54db 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -38,5 +38,5 @@ searchindex.js requirements.txt # vendorized vendor/* -ISSUE_TEMPLATE.md -PULL_REQUEST_TEMPLATE.md +# github configuration +.github/* diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index da30d3ba1d..0000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ -Make sure these boxes are checked before submitting your issue - thank you! - -- [ ] I have checked the superset logs for python stacktraces and included it here as text if there are any. -- [ ] I have reproduced the issue with at least the latest released version of superset. -- [ ] I have checked the issue tracker for the same issue and I haven't found one similar. - - -### Superset version - - -### Expected results - - -### Actual results - - -### Steps to reproduce - - diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7d662820df..0000000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,23 +0,0 @@ -##### SUMMARY - - -##### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF - - -##### TEST PLAN - - -##### ADDITIONAL INFORMATION - - - [ ] Has associated issue: - [ ] Changes UI - [ ] Requires DB Migration. Confirm DB Migration upgrade and downgrade tested. - [ ] Introduces new feature or API - [ ] Removes existing feature or API - [ ] Fixes bug - [ ] Refactors code - [ ] Adds test(s) - -##### REVIEWERS -