Latest process updates #43
Merged
+92
−52
Conversation
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
Updated references from 'Copilot' to 'GitHub Copilot' and improved clarity in the README.
Updated the contributing guidelines to clarify contribution process and provide detailed instructions for creating issues and feature requests.
Updated support documentation to clarify issue filing and project maintenance status.
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes documentation formatting and improves clarity across the project's core documentation files. The updates convert all headings to sentence case, ensure consistent terminology usage (particularly for "GitHub Copilot" and "a11y scanner"), and add visual enhancements like emojis throughout the README.
Key changes:
- Clarified that the project is in public preview (not beta) and that GitHub Copilot is optional
- Reorganized "Learn more" sections to improve logical flow and remove duplicate links
- Updated contribution guidelines to explicitly state that PRs are not being accepted, while encouraging testing, feedback, and issue creation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updated project description, requirements section, added emojis, reorganized learning resources, and standardized terminology and heading case |
| SUPPORT.md | Converted headings to sentence case, clarified project status as public preview, and updated terminology for consistency |
| CONTRIBUTING.md | Changed heading level, expanded contribution guidelines to clarify that PRs aren't accepted but issues and feedback are welcome |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
smockle
reviewed
Oct 27, 2025
| - **GitHub Actions** enabled in your repository | ||
| - **GitHub Issues** enabled in your repository | ||
| - **Available GitHub Actions minutes** for your account | ||
| - **Admin access** to add repository secrets |
There was a problem hiding this comment.
Suggested change
| - **Admin access** to add repository secrets | |
| - **Write access** (or higher) to add repository secrets |
smockle
reviewed
Oct 27, 2025
| - A clear and descriptive title | ||
| - Detailed steps to reproduce (for bugs) | ||
| - Expected vs. actual behavior | ||
| - Your environment details (OS, browser, GitHub Actions runner, etc.) |
There was a problem hiding this comment.
Suggested change
| - Your environment details (OS, browser, GitHub Actions runner, etc.) | |
| - Your workflow file (with sensitive data removed) | |
| - Your environment details (OS, browser, GitHub Actions runner, etc.) |
smockle
approved these changes
Oct 27, 2025
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 PR updates the README, CONTRIBUTING, and SUPPORT documentation to improve clarity and consistency. Key changes include: adding emojis and visual improvements throughout the README, reorganizing "Learn more" links to remove duplicates and improve logical flow, updating the Requirements section to clarify what's needed (including that GitHub Copilot is optional), converting all headings to sentence case, ensuring consistent terminology ("a11y scanner"/"accessibility scanner" and "GitHub Copilot"), and updating CONTRIBUTING and SUPPORT files to clarify that we're not accepting PRs at this time but welcome testing, feedback, and issue creation. The documentation now provides a clearer path for users to get started while setting appropriate expectations about contributions and feature requests.