docs: add PR and issue templates - #38
Merged
Merged
Conversation
MVTB had no PR or issue templates at all. Adds a short PR template (Summary/Test plan checklist, no stale branch-workflow instructions) and two GitHub issue forms (bug report, feature request) with the minimum fields that would have actually sped up triage on past issues -- version, Python version, OS, expected/actual, minimal repro for bugs; just a problem statement required for features. config.yml disables blank issues now that Discussions is enabled, routing general questions there instead. Guinea pig for the same rollout across RTB/bdsim/spatialgeometry (swift once its own main-branch migration lands); see toolbox-maintainer skill for the full cross-repo policy.
Up to standards ✅🟢 Issues
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.github/pull_request_template.md: short thanks-for-contributing line,## Summary/## Test planchecklist, no stale branch-workflow instructions (unlike RTB's existing template, which still references afuturebranch that no longer exists there).bug_report.yml(version, Python version, OS, expected/actual behavior, minimal repro -- all required) andfeature_request.yml(only the problem statement required, proposal/alternatives optional).config.yml: disables blank issues now that Discussions is enabled on this repo, routing general questions there instead of into an ill-fitting bug/feature form.toolbox-maintainerskill for the full cross-repo policy. SMTB is excluded (now effectively governed by RAI-Inst).Test plan
python3 -c "import yaml; yaml.safe_load(...)".github.com/petercorke/machinevision-toolbox-python/issues/templates/editto see it rendered before merging.