#changelog-md #changelog #keep #generate #format #parser

keep-a-changelog

Rust library for generating and manipulating CHANGELOG.md files that use the Keep A Changelog format

5 releases

0.1.4 Jul 10, 2024
0.1.3 Jun 8, 2024
0.1.2 May 20, 2024
0.1.1 May 18, 2024
0.1.0 Apr 28, 2024

#717 in Development tools

Download history 530/week @ 2024-10-26 779/week @ 2024-11-02 662/week @ 2024-11-09 645/week @ 2024-11-16 243/week @ 2024-11-23 351/week @ 2024-11-30 428/week @ 2024-12-07 229/week @ 2024-12-14 292/week @ 2024-12-21 198/week @ 2024-12-28 166/week @ 2025-01-04 240/week @ 2025-01-11 275/week @ 2025-01-18 202/week @ 2025-01-25 118/week @ 2025-02-01 54/week @ 2025-02-08

729 downloads per month
Used in pcu

MIT license

65KB
1.5K SLoC

Keep A Changelog Logo

Rust library for generating and manipulating CHANGELOG.md files that use the Keep A Changelog format.

Overview

This library is an adoption of the oscarotero/keep-a-changelog NPM package for Rust.

Installation

Add the following to your Cargo.toml:

[dependencies]
keep-a-changelog = "0.1"

Contribute

First off, thanks for taking the time to contribute! Now, take a moment to be sure your contributions make sense to everyone else.

Reporting Issues

Found a problem? Want a new feature? First of all, see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope and avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/keep-a-changelog-rs
  • Navigate to the newly cloned directory: cd keep-a-changelog-rs
  • Create a new branch for the new feature: git checkout -b feature/my-new-feature
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin feature/my-new-feature
  • Submit a pull request with full remarks documenting your changes.

License

MIT License © Semen Loktionov

Dependencies

~6.5MB
~124K SLoC