From d952d602c252d7050249aa1a7491625d0a554d8a Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Mon, 17 Aug 2026 12:31:12 +1000 Subject: [PATCH] docs: convert issue templates to YAML forms, add PR template Replaces the two old Markdown issue templates with GitHub's structured YAML form syntax (matching the convention already used in MVTB), same content and fields, just the nicer form UI: - 0repository-bug-report.yml: repo-specific bugs, still redirects toolbox-specific reports to RTB/MVTB/SMTB/bdsim/Swift/SG/pgraph's own issue trackers - 1errata.yml: book errata (page number, location, description) Adds a pull_request_template.md scoped to what's actually true here -- no CI/bots exist in this repo, so unlike MVTB's template this one just asks that `pytest tests/` passes locally and that new code follows the type-hint/docstring conventions. --- .../ISSUE_TEMPLATE/0repository-bug-report.md | 42 ----------- .../ISSUE_TEMPLATE/0repository-bug-report.yml | 74 +++++++++++++++++++ .github/ISSUE_TEMPLATE/1errata.md | 22 ------ .github/ISSUE_TEMPLATE/1errata.yml | 43 +++++++++++ .github/pull_request_template.md | 15 ++++ 5 files changed, 132 insertions(+), 64 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/0repository-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/0repository-bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/1errata.md create mode 100644 .github/ISSUE_TEMPLATE/1errata.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/0repository-bug-report.md b/.github/ISSUE_TEMPLATE/0repository-bug-report.md deleted file mode 100644 index 0a03528..0000000 --- a/.github/ISSUE_TEMPLATE/0repository-bug-report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Repository bug report -about: Create a report to help us improve the `RVC3-python` repository -title: '' -labels: bug -assignees: petercorke - ---- - -**This report is for bugs with the `RVC3-python` repo: missing files, incorrect documentation, broken links etc.** - -**Reports related to specific software components used in the RVC3 book should be reported on the issues pages of those components, listed below. They will not be actioned if posted here.** - -- [Robotics Toolbox for Python](https://github.com/petercorke/robotics-toolbox-python/issues) -- [Machine Vision Toolbox for Python](https://github.com/petercorke/machinevision-toolbox-python/issues) -- [Spatial Maths Toolbox for Python](https://github.com/petercorke/spatialmath-python/issues) -- [bdsim: block diagram simulation for Python](https://github.com/petercorke/bdsim/issues) -- [Swift graphical simulator for Python](https://github.com/jhavl/swift/issues) -- [Spatial Geometry Toolbox for Python](https://github.com/jhavl/spatialgeometry/issues) -- [PGraph, mathematical graph library for Python](https://github.com/petercorke/pgraph-python/issues) - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Provide the smallest possible code snippet that demonstrates the error. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**For problems related to graphics (please complete the following information):** - - For Python scripts run from the command line - - What OS are you using: [e.g. MacOS] - - For Jupyter notebooks - - Are you using Colab - - What browser are you using [e.g. chrome, safari] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/0repository-bug-report.yml b/.github/ISSUE_TEMPLATE/0repository-bug-report.yml new file mode 100644 index 0000000..66d3219 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0repository-bug-report.yml @@ -0,0 +1,74 @@ +name: Repository bug report +description: Create a report to help us improve the RVC3-python repository +labels: ["bug"] +assignees: ["petercorke"] +body: + - type: markdown + attributes: + value: | + This report is for bugs with the **RVC3-python repo itself**: missing files, + incorrect documentation, broken links, notebooks that won't run, etc. + + Reports related to a specific software component used in the book should be + reported on that component's own issues page instead — they will not be + actioned if posted here: + + - [Robotics Toolbox for Python](https://github.com/petercorke/robotics-toolbox-python/issues) + - [Machine Vision Toolbox for Python](https://github.com/petercorke/machinevision-toolbox-python/issues) + - [Spatial Maths Toolbox for Python](https://github.com/petercorke/spatialmath-python/issues) + - [bdsim: block diagram simulation for Python](https://github.com/petercorke/bdsim/issues) + - [Swift graphical simulator for Python](https://github.com/jhavl/swift/issues) + - [Spatial Geometry Toolbox for Python](https://github.com/jhavl/spatialgeometry/issues) + - [PGraph, mathematical graph library for Python](https://github.com/petercorke/pgraph-python/issues) + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: repro + attributes: + label: To reproduce + description: Provide the smallest possible code snippet, or exact steps, that demonstrate the error. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating system + description: If you're running a script from the command line. + options: [macOS, Linux, Windows, Other, Not applicable] + validations: + required: false + - type: dropdown + id: notebook-env + attributes: + label: Notebook environment + description: If this is about a Jupyter notebook. + options: [Google Colab, Local Jupyter, Not applicable] + validations: + required: false + - type: input + id: browser + attributes: + label: Browser + description: If using Colab or local Jupyter. + placeholder: "e.g. Chrome, Safari" + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context, or screenshots, about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/1errata.md b/.github/ISSUE_TEMPLATE/1errata.md deleted file mode 100644 index c414655..0000000 --- a/.github/ISSUE_TEMPLATE/1errata.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Errata -about: 'Report errors in the book: Robotics, Vision & Control 3e, in Python' -title: '' -labels: errata -assignees: petercorke - ---- - -Errors in books are a nightmare for the readers and the author! If you spot something that is wrong, or something could be improved (clearer, less confusing, less ambiguous) please log it here. This will help fellow readers of the book, and will improve future editions of the book. - -**Where is the error?** -Please provide a clear and concise description of where the problem is. Give page number and then clearly describe where on the page the issue is. Provide existing text as a reference, or specify the area relative to equations and figures. - -**What is the error?** -A clear and concise description of how you would like to see the text changed, and why. - -**Additional context** -Add any other context or screenshots about the feature request here. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/1errata.yml b/.github/ISSUE_TEMPLATE/1errata.yml new file mode 100644 index 0000000..5f5f768 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1errata.yml @@ -0,0 +1,43 @@ +name: Errata +description: 'Report errors in the book: Robotics, Vision & Control 3e, in Python' +labels: ["errata"] +assignees: ["petercorke"] +body: + - type: markdown + attributes: + value: | + Errors in books are a nightmare for the readers and the author! If you spot + something that is wrong, or something that could be improved (clearer, less + confusing, less ambiguous) please log it here. This will help fellow readers + of the book, and will improve future editions of the book. + - type: input + id: page + attributes: + label: Page number + description: Or a figure/equation/table number if that's clearer. + placeholder: "e.g. 142, or 'Fig 3.5 caption'" + validations: + required: true + - type: textarea + id: location + attributes: + label: Where is the error? + description: >- + Clearly describe where on the page the issue is. Provide the existing text + as a reference, or specify the location relative to an equation or figure. + validations: + required: true + - type: textarea + id: error + attributes: + label: What is the error? + description: A clear and concise description of how you'd like to see the text changed, and why. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context, or screenshots, here. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..4e2086b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +Thanks for contributing to RVC3-python! + +## Summary + + + +## Related issue + + + +## Checklist + +- [ ] Tests pass locally (`pytest tests/`, and `pytest tests/ --runall` if this touches a notebook or an `RVC3/examples` script) +- [ ] New/changed code is type-hinted with modern syntax (`X | Y`, `list[X]`, not `Union`/`Optional`/`List`) +- [ ] Docstrings updated (reST style: `:param:`, `:returns:`; type hints in the signature cover types now, `:type:`/`:rtype:` are rarely needed)