python-tuf
python-tuf copied to clipboard
theupdateframework
Enhancing The Update Framework (Python - TUF) README
Description of the changes being introduced by the pull request:
-
Table of Contents: Added a Table of Contents to improve navigation and accessibility within the README.
-
Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.
-
Additional Badges: Included additional badges to highlight key aspects such as version, license, tech-stack, and community support, providing users with quick access to essential information.
-
Back to Top Button: Added a "Back to Top" button at the bottom of the README to facilitate easy navigation within the document.
-
Installation Section: Added an Installation section to provide users with clear guidance on how to install the software.
-
Contact Section Enhancement: Separated the Mailing List and CNCF Slack links for better readability and organization within the Contact section.
-
CNCF Logo Addition: Added the CNCF logo at the bottom of the README to acknowledge the project's affiliation with the Cloud Native Computing Foundation.
Before:
After:
Fixes #2654
Reviewers:
@trishankatdatadog @JustinCappos
@trishankatdatadog @JustinCappos please review this PR for the issue #2654
2. Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.
This change makes the logo invisible with default GitHub settings (You are using dark theme on GitHub so see the opposite effect).
- Logo Color: Changed the logo color from black to white to enhance visibility and improve the overall aesthetic of the document.
This change makes the logo invisible with default GitHub settings (You are using dark theme on GitHub so see the opposite effect).
To ensure the logo is visible in both light and dark themes, a solution that automatically switches the logo based on the user's selected theme preference can be implemented. This strategy involves utilizing two different logo versions (one for light theme and one for a dark theme) and utilizing HTML and CSS to manage the theme-based switching.
Pull Request Test Coverage Report for Build 9544443646
Warning: This coverage report may be inaccurate.
This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
- For more information on this, see Tracking coverage changes with pull request builds.
- To avoid this issue with future PRs, see these Recommended CI Configurations.
- For a quick fix, rebase this PR at GitHub. Your next report should be accurate.
Details
- 0 of 0 changed or added relevant lines in 0 files are covered.
- No unchanged relevant lines lost coverage.
- Overall coverage remained the same at 96.805%
| Totals | |
|---|---|
| Change from base Build 9362602883: | 0.0% |
| Covered Lines: | 1554 |
| Relevant Lines: | 1591 |
💛 - Coveralls
@trishankatdatadog @JustinCappos please review this PR for the issue #2654
Sorry, I'm running out of B/W... please try someone else? @jku has been massively helpful here, thanks!
@jku already left a thorough review here. From what I see, the key improvement of this PR is to use the correct markup for the section headers. @shubhusion, do you plan to address the review comments?
@jku already left a thorough review here. From what I see, the key improvement of this PR is to use the correct markup for the section headers. @shubhusion, do you plan to address the review comments?
@lukpueh yeah I will make changes as specified
Pull Request Test Coverage Report for Build 10125811756
Warning: This coverage report may be inaccurate.
This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
- For more information on this, see Tracking coverage changes with pull request builds.
- To avoid this issue with future PRs, see these Recommended CI Configurations.
- For a quick fix, rebase this PR at GitHub. Your next report should be accurate.
Details
- 0 of 0 changed or added relevant lines in 0 files are covered.
- No unchanged relevant lines lost coverage.
- Overall coverage remained the same at 96.805%
| Totals | |
|---|---|
| Change from base Build 10083770686: | 0.0% |
| Covered Lines: | 1554 |
| Relevant Lines: | 1591 |
💛 - Coveralls
I'm closing this since no action in 2 months.
Please reopen if you get to it at a later date