ReadMe Cleanup #95
Merged
ReadMe Cleanup #95
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
Signed-off-by: Kevin Ullyott <ullyott.kevin@gmail.com>
Signed-off-by: Kevin Ullyott <ullyott.kevin@gmail.com>
Signed-off-by: Kevin Ullyott <ullyott.kevin@gmail.com>
Signed-off-by: Kevin Ullyott <ullyott.kevin@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up the main README.md and introduces a new CONTRIBUTING.md file to improve project documentation and separate contributor guidelines from the main readme.
Changes:
- Removed emoji from the MeliorStan title in README.md
- Updated and simplified the Contributing section in README.md to reference the new CONTRIBUTING.md
- Removed redundant acknowledgments from README.md (PHP-Parser and PHP Community)
- Removed the "Request Features" link from the footer
- Added comprehensive CONTRIBUTING.md with development setup, architecture overview, testing guidelines, and code style instructions
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Cleaned up title, simplified Contributing section to reference external file, removed redundant acknowledgments, and simplified footer links |
| CONTRIBUTING.md | New comprehensive contributing guide with development setup, project architecture, testing conventions, and code style guidelines |
Signed-off-by: Kevin Ullyott <ullyott.kevin@gmail.com>
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.
Updates various entries in the main README.md and adds a proper CONTRIBUTION.md