Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: delete CHANGELOG_old.md #2914

Merged
merged 3 commits into from
May 23, 2024
Merged

docs: delete CHANGELOG_old.md #2914

merged 3 commits into from
May 23, 2024

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented May 18, 2024

Deletes the CHANGELOG_old.md which contains the changelog prior to v6.

IMO at this point this file is hardly relevant anymore and can be deleted.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels May 18, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone May 18, 2024
@ST-DDT ST-DDT requested review from a team May 18, 2024 19:19
@ST-DDT ST-DDT self-assigned this May 18, 2024
Copy link

netlify bot commented May 18, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit a38bab5
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/664f26ea2408a60008906489
😎 Deploy Preview https://deploy-preview-2914.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ST-DDT
Copy link
Member Author

ST-DDT commented May 18, 2024

I also considered trimming the "current" CHANGELOG.md (in a separate PR), to v8+ or v9+ with a link at the end to previous major versions.
What do you think?

Copy link

codecov bot commented May 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (80b4a23) to head (70b04c7).

Current head 70b04c7 differs from pull request most recent head a38bab5

Please upload reports for the commit a38bab5 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2914      +/-   ##
==========================================
- Coverage   99.96%   99.95%   -0.01%     
==========================================
  Files        2977     2977              
  Lines      215421   215422       +1     
  Branches      952      602     -350     
==========================================
- Hits       215349   215335      -14     
- Misses         72       87      +15     

see 3 files with indirect coverage changes

@xDivisionByZerox
Copy link
Member

xDivisionByZerox commented May 18, 2024

I also considered trimming the "current" CHANGELOG.md (in a separate PR), to v8+ or v9+ with a link at the end to previous major versions. What do you think?

I'd prefer not to do this. I find myself looking into changelog files of other libraries. It's quite frustrating when you want to do a fuzzy search for when a specific thing was changed in the changelog file, but you only have the latest version in there.
Sure, I could check the git history, but then I'd need to clone the repository first, which I often don't want.

Also, what would we gain by trimming the changelogs content to the current version? First thing that came to mind for me was better load time when viewing the file online. That should be neglectably low, right?

Edit:
I don't think that my argument applies for the old changelog files, as these changes have been made by a separate repository before. So even if you'd want to find a specific changelog entry, we wouldn't be the one responsible for it.

@matthewmayer
Copy link
Contributor

Why not leave a link to the final revision of changelog_old at the bottom of changelog together with an explanatory note.

If I want to understand the history of a project i look at its changelog, so that would better clarify that the project didn't start at v6.

@ST-DDT
Copy link
Member Author

ST-DDT commented May 23, 2024

There is a short text linking to the old one:

For changes prior to version v6, see the old changelog.

Do you want to us to explain the reason why it is cut there?
I'm not sure how to formulate that. Maybe like this?

These changes were made before the current maintainer team took over, for more information read https://fakerjs.dev/about/announcements/2022-01-14.html#i-heard-something-happened-what-s-the-tldr

@matthewmayer
Copy link
Contributor

matthewmayer commented May 23, 2024

Sorry, my bad, you already made this change. This is sufficient

image

@ST-DDT ST-DDT enabled auto-merge (squash) May 23, 2024 11:22
@ST-DDT ST-DDT merged commit b97984c into next May 23, 2024
18 checks passed
@ST-DDT ST-DDT deleted the docs/CHANGELOG-purge branch May 23, 2024 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants