Add change log

[Eyob94]

Summary by CodeRabbit

• New Features
  • Introduced a changelog file to document version history and notable changes in each release.
• Documentation
  • Provided structured versioning information, including release dates and summaries for the first three versions.

[coderabbitai]

Walkthrough

This update introduces a CHANGELOG.md file to the project, documenting the version history and notable changes for each release. The changelog includes three versions: 0.1.0, which adds memory locking functions; 0.1.1, which implements comparison traits for specific types; and 0.1.2, which adds the changelog itself. This structured documentation aims to enhance tracking of the project's development over time.

Changes

Files	Change Summary
CHANGELOG.md	Added a changelog documenting version history and notable changes.

Poem

🐇 In the garden of code, changes bloom bright,
A changelog appears, a guiding light.
With traits and functions, our project takes flight,
Hop along, dear users, all is now right!
Let’s track our journey, with each little byte! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4810983 and 449f07e.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Additional context used

LanguageTool

CHANGELOG.md

[grammar] ~5-~5: This phrase is duplicated. You should probably use “Add Changelog” only once.
Context: ...ps://github.com//pull/7) Add Changelog - Add Changelog ## 0.1.1 - 2024-09-11 - [#6](https://...

(PHRASE_REPETITION)

Additional comments not posted (2)

CHANGELOG.md (2)

1-16: LGTM!

The changelog follows a clear and standard format, documenting the version history and notable changes for each release. The content is well-structured and informative.

Tools

LanguageTool

[grammar] ~5-~5: This phrase is duplicated. You should probably use “Add Changelog” only once.
Context: ...ps://github.com//pull/7) Add Changelog - Add Changelog ## 0.1.1 - 2024-09-11 - [#6](https://...

(PHRASE_REPETITION)

---

5-6: Ignore the LanguageTool hint.

The duplicated phrase "Add Changelog" flagged by LanguageTool is not an error, but an intentional repetition of the pull request title and the change description. This is a common and acceptable pattern in changelogs.

Tools

LanguageTool

[grammar] ~5-~5: This phrase is duplicated. You should probably use “Add Changelog” only once.
Context: ...ps://github.com//pull/7) Add Changelog - Add Changelog ## 0.1.1 - 2024-09-11 - [#6](https://...

(PHRASE_REPETITION)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.