Update readme and project links #353
Merged
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the project's documentation and metadata by adding visual branding and standardizing project URLs. The changes improve discoverability and user experience by providing a professional logo and well-structured project links.
- Updates
pyproject.tomlwith standardized project URLs following Python packaging conventions - Adds light and dark theme logo SVG files for better visual presentation
- Updates README.md with centered logo display and quick navigation links
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pyproject.toml | Replaces single generic project URL with standardized well-known project URLs (Homepage, Changelog, Source, Documentation, Issues, Funding) |
| images/logo-light.svg | Adds new SVG logo optimized for light theme with Django branding and S3 bucket icon |
| images/logo-dark.svg | Adds new SVG logo optimized for dark theme with inverted colors for dark backgrounds |
| README.md | Adds centered header section with theme-aware logo and quick navigation links to documentation, issues, changelog, and funding |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Homepage = "https://github.com/codingjoe/django-s3file" | ||
| Changelog = "https://github.com/codingjoe/django-s3file/releases" | ||
| Source = "https://github.com/codingjoe/django-s3file" | ||
| Releasenotes = "https://github.com/codingjoe/django-s3file/releases/latest" |
There was a problem hiding this comment.
The label "Releasenotes" should be "Release Notes" (two words) to match standard conventions. According to Python packaging documentation for well-known project URLs, release notes should be specified as two separate words or hyphenated.
Suggested change
| Releasenotes = "https://github.com/codingjoe/django-s3file/releases/latest" | |
| "Release Notes" = "https://github.com/codingjoe/django-s3file/releases/latest" |
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.
No description provided.