Reformat new release repository template. #296
Draft
Conversation
This file contains 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
This is a start at addressing some of the feedback provided in #125 My objective in using a big issue template with lots of explanatory comments was to make the documentation as local to its use as possible without cluttering the resulting issue (after all, the submitter can't both read the formatted text and fill out the template at the same time). But as I iterate, I'm starting to think that [Issue Forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) and a link to guiding documentation would be easier to follow and result in stil cleaner issues than this format. So I may abandon this effort in pursuit of a wider refactor.
moriarty
approved these changes
Jul 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a start at addressing some of the feedback provided in #125
My objective in using a big issue template with lots of explanatory comments was to make the documentation as local to its use as possible without cluttering the resulting issue (after all, the submitter can't both read the formatted text and fill out the template at the same time). But as I iterate, I'm starting to think that Issue Forms and a link to guiding documentation would be easier to follow and result in stil cleaner issues than this format. So I may abandon this effort in pursuit of a wider refactor.