Skip to content

docs: add release changelog and README link - #353

Merged
kOaDT merged 1 commit into
kOaDT:mainfrom
Iqranawaz-debug:docs/add-changelog
Oct 20, 2026
Merged

kOaDT merged 1 commit into
kOaDT:mainfrom
Iqranawaz-debug:docs/add-changelog

Conversation

@Iqranawaz-debug

Copy link
Copy Markdown
Contributor

Description

Closes #314

  • Added a manually maintained CHANGELOG.md covering all 42 published releases, from 1.3.0 through v2.22.0.
  • Organized release highlights using Keep a Changelog conventions, including Added, Changed, Fixed, and Security categories where applicable.
  • Linked each changelog version to its corresponding GitHub release.
  • Added a link to CHANGELOG.md in the root README.md for easier discoverability.
  • Included a maintenance note to keep the changelog updated with future releases.

Type of change

  • Bug fix
  • New feature (e-commerce site improvement)
  • New vulnerability / flag
  • Walkthrough / writeup
  • Documentation update
  • Other (please describe):

Testing done

  • Ran npm run format successfully.
  • Verified CHANGELOG.md with npx prettier CHANGELOG.md --check.
  • Verified staged changes with git diff --cached --check.
  • Confirmed that only CHANGELOG.md and README.md were included in the commit.

Checklist

  • Documentation updated (if applicable)

If adding a new challenge

Not applicable — documentation-only contribution.

@github-actions github-actions Bot added the size/XL PR size: XL label Oct 20, 2026
@github-actions

Copy link
Copy Markdown

Welcome @Iqranawaz-debug, and thanks for your first PR here!

Code Quality and the exploitation suite are running now. You can follow them in the Checks tab. If one goes red and the message isn't obvious, ask in this thread rather than force-pushing blind.

Contributing guide · Code of conduct. A maintainer will pick this up shortly.

@kOaDT kOaDT left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @Iqranawaz-debug, merging this! 🎉

Heads-up: I'll follow up with a separate PR that regenerates the entries from the release notes. A few breaking changes and challenge names got lost in the summaries, and the compare links are still missing. The Keep a Changelog structure stays.

@kOaDT
kOaDT merged commit 86402a8 into kOaDT:main Oct 20, 2026
7 checks passed
@github-actions

Copy link
Copy Markdown

Merged — and it's your first one here, @Iqranawaz-debug. Thank you!

If the project was useful to you, a star helps other people find it!

@Iqranawaz-debug

Copy link
Copy Markdown
Contributor Author

Thank you so much for reviewing and merging my PR! I appreciate the feedback and the opportunity to contribute. Glad the changelog structure is useful!

@Iqranawaz-debug
Iqranawaz-debug deleted the docs/add-changelog branch October 20, 2026 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XL PR size: XL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add CHANGELOG.md seeded from the releases

2 participants