Update issue-workflow.md#603
Open
GordonLtron wants to merge 1 commit into
Open
Conversation
**Review of Issue Specification and Guidelines** This document contains several careless copy-paste artifacts and missing punctuation marks that must be fixed before merging. The current state is unpolished and unprofessional. **Required Changes (Confidence Level: High):** 1. **Remove Web Anchor Artifacts:** Delete all instances of the `¶` symbol from the headers (e.g., `Issue Specification and Guidelines¶`, `Submitting an Issue¶`, `1. Search Existing Issues¶`). These are leftover artifacts from copying HTML content. 2. **Fix Missing Punctuation:** Multiple sentences are mashed together without periods. Add periods in the following locations: * Change `...as an Issue Participating in...` to `...as an issue. Participating in...` * Change `...submit an Issue Please follow...` to `...submit an issue. Please follow...` * Add a period at the end of the "Assigning Issues" bullet point: `...discussion of the issue.` 3. **Add Delimiters to List Items:** The bullet points under "Choose and Submit an Issue Type" and "Issue Handling Process" run the titles directly into the descriptions. You must add a colon (`:`) or a line break to separate them. * *Example:* Change `Ask a question Please describe...` to `**Ask a question:** Please describe...` * *Example:* Change `Tagging Issues New issues...` to `**Tagging Issues:** New issues...` 4. **Standardize Capitalization:** Avoid randomly capitalizing the word `Bug` in the middle of sentences. Change it to lowercase `bug` throughout the text (e.g., `find a bug`, `reproduce the bug`). It is also recommended to use lowercase `issue` when referring to the general concept rather than a specific UI element. Please revise the document to ensure basic structural integrity.
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.
Review of Issue Specification and Guidelines
This document contains several careless copy-paste artifacts and missing punctuation marks that must be fixed before merging. The current state is unpolished and unprofessional.
Fix Missing Punctuation: Multiple sentences are mashed together without periods. Add periods in the following locations:
...as an Issue Participating in...to...as an issue. Participating in......submit an Issue Please follow...to...submit an issue. Please follow......discussion of the issue.Standardize Capitalization: Avoid randomly capitalizing the word
Bugin the middle of sentences. Change it to lowercasebugthroughout the text (e.g.,find a bug,reproduce the bug). It is also recommended to use lowercaseissuewhen referring to the general concept rather than a specific UI element.Please revise the document to ensure basic structural integrity.