From ded3c1c0b42b53912858e4619dd90fa6fa2d0a80 Mon Sep 17 00:00:00 2001 From: msschwartz21 Date: Fri, 17 Nov 2023 11:40:52 -0800 Subject: [PATCH 1/4] Add pull request templates --- .github/PULL_REQUEST_TEMPLATE/general.md | 30 +++++++++++++++++++ .../new_matcher_metric.md | 18 +++++++++++ 2 files changed, 48 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/general.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE/general.md new file mode 100644 index 00000000..70267dd0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/general.md @@ -0,0 +1,30 @@ +# Proposed Change +Briefly describe the contribution. If it resolves an issue or feature request, be sure to link to that issue. + +# Types of Changes +What types of changes does your code introduce? Put an x in the boxes that apply. +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature or enhancement +- [ ] Documentation update +- [ ] Tests and benchmarks +- [ ] Maintenance (e.g. dependencies, CI, releases, etc.) + +Which topics does your change affect? Put an x in the boxes that apply. +- [ ] Loaders +- [ ] Matchers +- [ ] Track Errors +- [ ] Metrics +- [ ] Core functionality (e.g. `TrackingGraph`, `run_metrics`, `cli`, etc.) + +# Checklist +Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code. + +- [ ] I have read the developer/contributing docs. +- [ ] I have added tests that prove that my feature works in various situations or tests the bugfix (if appropriate). +- [ ] I have checked that I maintained or improved code coverage. +- [ ] I have checked the benchmarking action to verify that my changes did not adversely affect performance. +- [ ] I have written docstrings and checked that they render correctly in the Read The Docs build (created after the PR is opened). +- [ ] I have updated the general documentation including Metric descriptions and example notebooks if necessary. + +# Further Comments +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md b/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md new file mode 100644 index 00000000..b85ff09a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md @@ -0,0 +1,18 @@ +# Proposed Matcher or Metric Addition +- [ ] Matcher +- [ ] Metric + +Briefly describe your new Matcher or Metric class, including links to publication or other source code if relevant. A full description should be included in the documentation. If it resolves a feature request, be sure to link to that issue. + +# Checklist +Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code. + +- [ ] I have read the developer/contributing docs. +- [ ] I have added tests that prove that my feature works in various situations. +- [ ] I have checked that I maintained or improved code coverage. +- [ ] I have added benchmarking functions for my change `tests/bench.py`. +- [ ] I have added a page to the documentation with a complete description of my matcher/metric including any references. +- [ ] I have written docstrings and checked that they render correctly in the Read The Docs build (created after the PR is opened). + +# Further Comments +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... \ No newline at end of file From 1e72ee77ed9f34f6cd218628dfd9581d9f320490 Mon Sep 17 00:00:00 2001 From: msschwartz21 Date: Fri, 17 Nov 2023 11:44:34 -0800 Subject: [PATCH 2/4] Add config for pr templates --- .github/PULL_REQUEST_TEMPLATE/general.md | 9 +++++++++ .github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE/general.md index 70267dd0..b37fe15f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/general.md +++ b/.github/PULL_REQUEST_TEMPLATE/general.md @@ -1,3 +1,12 @@ +--- +name: General Pull Request +about: Bugfixes, enhancements, documentation, etc. +title: '' +labels: '' +assignees: '' + +--- + # Proposed Change Briefly describe the contribution. If it resolves an issue or feature request, be sure to link to that issue. diff --git a/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md b/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md index b85ff09a..fe3f4188 100644 --- a/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_matcher_metric.md @@ -1,3 +1,12 @@ +--- +name: New Matcher or Metric +about: A new Matcher or Metric class +title: '' +labels: '' +assignees: '' + +--- + # Proposed Matcher or Metric Addition - [ ] Matcher - [ ] Metric From e197fc31349da82eac64c775d3267308c213a56d Mon Sep 17 00:00:00 2001 From: msschwartz21 Date: Fri, 17 Nov 2023 11:51:28 -0800 Subject: [PATCH 3/4] New issue templates --- .../bugs.md} | 18 ++++++++-- .github/ISSUE_TEMPLATE/features.md | 36 +++++++++++++++++++ 2 files changed, 52 insertions(+), 2 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bugs.md} (57%) create mode 100644 .github/ISSUE_TEMPLATE/features.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bugs.md similarity index 57% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bugs.md index 3fd3d74e..8d86e4a8 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -1,15 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + * traccuracy version: * Python version: * Operating System: -### Description +# Description Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. -### What I Did +# What I Did ``` Paste the command(s) you ran and the output. If there was a crash, please include the traceback here. ``` + +# Severity +- [ ] Unusable +- [ ] Annoying, but still functional +- [ ] Very minor \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/features.md b/.github/ISSUE_TEMPLATE/features.md new file mode 100644 index 00000000..d1c44dd1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/features.md @@ -0,0 +1,36 @@ +--- +name: Feature +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +# Description + +Please describe the feature that you would like to see implemented in `traccuracy`. + +# Topics + +What types of changes are you suggesting? Put an x in the boxes that apply. +- [ ] New feature or enhancement +- [ ] Documentation update +- [ ] Tests and benchmarks +- [ ] Maintenance (e.g. dependencies, CI, releases, etc.) + +Which topics does your change affect? Put an x in the boxes that apply. +- [ ] Loaders +- [ ] Matchers +- [ ] Track Errors +- [ ] Metrics +- [ ] Core functionality (e.g. `TrackingGraph`, `run_metrics`, `cli`, etc.) + +# Priority +- [ ] This is an essential feature +- [ ] Nice to have +- [ ] Future idea + +# Are you interested in contributing? +- [ ] Yes! :tada: +- [ ] No :slightly_frowning_face: \ No newline at end of file From 4c67f66d772d09d1c695772e2396e58155db2683 Mon Sep 17 00:00:00 2001 From: msschwartz21 Date: Fri, 17 Nov 2023 11:52:06 -0800 Subject: [PATCH 4/4] Minimal example --- .github/ISSUE_TEMPLATE/bugs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index 8d86e4a8..61b0bc6f 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -16,7 +16,7 @@ assignees: '' Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. -# What I Did +# Minimal example to reproduce the bug ``` Paste the command(s) you ran and the output.