Update README.md #296
Closed
Update README.md #296
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
Improved clarity to README, but Copilot Agent mode made these suggestions, so they need better human review than I can provide ;)
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md to improve clarity and update the documentation structure for the GitHub Maintainer Month project.
- Updated website URL link from GitHub Maintainer Month’s .com to .io
- Revised Table of Contents with new sections such as Prerequisites and Testing, and adjusted command examples for installation, usage, and build
- Added sections for Prerequisites, Testing, Project Structure, Adding Events, and Deployment
The-Best-Codes
suggested changes
Apr 24, 2025
Contributor
The-Best-Codes
left a comment
The-Best-Codes
left a comment
There was a problem hiding this comment.
Looks great to me! Copilot left two comments that are both completely wrong. 🤣
I just found one issue. The site is a subdomain on github.com, not github.io.
Contributor
Author
|
@chrisreddington made some of these updates already in #304 |
Contributor
Author
|
Closing since partially covered by more recent PR |
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.
Improved clarity to README, but Copilot Agent mode made these suggestions, so they need better human review than I can provide ;)