docs: convert issue templates to YAML forms, add PR template - #42
Open
petercorke wants to merge 1 commit into
Open
docs: convert issue templates to YAML forms, add PR template#42petercorke wants to merge 1 commit into
petercorke wants to merge 1 commit into
Conversation
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.
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
0repository-bug-report.yml— repo-specific bugs, still redirects toolbox-specific reports to RTB/MVTB/SMTB/bdsim/Swift/SG/pgraph's own trackers1errata.yml— book errata (page number, location, description)pull_request_template.md, scoped to what's actually true in this repo (no CI/bots) — asks thatpytest tests/passes locally and that new code follows the repo's type-hint/docstring conventions.Deliberately left out of scope (discussed, not wanted): moving the toolbox-routing list into
config.ymlcontact_links, disabling blank issues, and a feature-request template.Test plan
yaml.safe_load)