nash1111 / nash1111-tech-blog

0 stars 0 forks source link

chore: update readme #95

Closed nash1111 closed 3 days ago

nash1111 commented 3 days ago

User description

Why

Closes #90

What


PR Type

documentation, enhancement


Description


Changes walkthrough ๐Ÿ“

Relevant files
Documentation
README.md
Enhance README with testing and screenshot details             

README.md
  • Added detailed description of automated testing and screenshots.
  • Included links to screenshots for different devices.
  • +14/-1   
    Enhancement
    lastUpdated.ts
    Update lastUpdated timestamp                                                         

    public/lastUpdated.ts - Updated the `lastUpdated` timestamp.
    +1/-1     
    currentIssues.json
    Refresh current issues list                                                           

    public/currentIssues.json - Updated the list of current issues.
    +1/-1     

    ๐Ÿ’ก PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    cloudflare-pages[bot] commented 3 days ago

    Deploying nash1111-tech-blog with  Cloudflare Pages  Cloudflare Pages

    Latest commit: 5625b63
    Status:โšก๏ธ  Build in progress...

    View logs

    github-actions[bot] commented 3 days ago

    PR Reviewer Guide ๐Ÿ”

    โฑ๏ธ Estimated effort to review [1-5] 2
    ๐Ÿงช Relevant tests No
    ๐Ÿ”’ Security concerns No
    โšก Key issues to review Possible Bug:
    The PR includes updates to public/currentIssues.json and public/lastUpdated.ts which are straightforward, but it's crucial to ensure that the timestamp and issue updates reflect the current state accurately. Double-check if the changes in currentIssues.json correctly represent the current issues status.
    Documentation Quality:
    Ensure that the links provided in the README.md for screenshots are valid and accessible. This is important for maintaining the integrity and usefulness of the documentation.
    github-actions[bot] commented 3 days ago

    PR Code Suggestions โœจ

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Replace the hardcoded date with dynamic date generation ___ **Consider using a dynamic date generation for lastUpdated instead of hardcoding the date.
    This can be achieved by using new Date().toISOString() which will automatically update the
    date and time to the current moment when the file is processed.** [public/lastUpdated.ts [1]](https://github.com/nash1111/nash1111-tech-blog/pull/95/files#diff-035b4dbf3d5271011cd9df19126b1f50c6b572d572ead51d3a7056b85bec0decR1-R1) ```diff -export const lastUpdated = "2024-06-25T14:22:09"; +export const lastUpdated = new Date().toISOString(); ```
    Suggestion importance[1-10]: 9 Why: Using dynamic date generation improves maintainability by ensuring the date is always current without manual updates. This is a significant enhancement.
    9
    Accessibility
    Add descriptive alt text to images for better accessibility ___ **It's recommended to add alt text for images to improve accessibility and SEO. For example,
    instead of an empty alt text, describe the content of the image.** [README.md [10]](https://github.com/nash1111/nash1111-tech-blog/pull/95/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R10-R10) ```diff -![BlogPage](https://raw.githubusercontent.com/nash1111/nash1111-tech-blog/master/test-results/screenshots/blog-page-iphone.png) +![Screenshot of the Blog Page on iPhone](https://raw.githubusercontent.com/nash1111/nash1111-tech-blog/master/test-results/screenshots/blog-page-iphone.png) ```
    Suggestion importance[1-10]: 8 Why: Adding alt text improves accessibility and SEO, which is important for inclusivity and search engine ranking. This is a valuable improvement.
    8
    Data consistency
    Ensure consistency in JSON data fields ___ **Ensure that the JSON data structure is consistent. For example, the body field should
    consistently contain meaningful data or be omitted if not used. Inconsistent data might
    lead to parsing errors or incorrect data handling in the application.** [public/currentIssues.json [1]](https://github.com/nash1111/nash1111-tech-blog/pull/95/files#diff-1a27d3828a7c20f8dc1d863aa066eae7d2e45873e77ccfa7cc636b42d9a6760bR1-R1) ```diff -{"body":"","number":94,"state":"OPEN","title":"blog page is too slow....","url":"https://github.com/nash1111/nash1111-tech-blog/issues/94"} +{"number":94,"state":"OPEN","title":"blog page is too slow....","url":"https://github.com/nash1111/nash1111-tech-blog/issues/94"} ```
    Suggestion importance[1-10]: 7 Why: Ensuring consistency in JSON data fields helps prevent parsing errors and improves data handling. This is a good practice for data integrity.
    7
    Best practice
    Use relative URLs for images to ensure robustness and faster loading ___ **Consider using relative URLs for images hosted in the same repository to ensure links do
    not break if the repository is moved or renamed. This also helps in loading images faster.** [README.md [10]](https://github.com/nash1111/nash1111-tech-blog/pull/95/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R10-R10) ```diff -![BlogPage](https://raw.githubusercontent.com/nash1111/nash1111-tech-blog/master/test-results/screenshots/blog-page-iphone.png) +![BlogPage](../test-results/screenshots/blog-page-iphone.png) ```
    Suggestion importance[1-10]: 6 Why: Using relative URLs can prevent broken links if the repository is moved or renamed and can improve loading times. This is a helpful best practice but not critical.
    6