#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

#592 in Development tools

Download history 547/week @ 2024-09-04 205/week @ 2024-09-11 233/week @ 2024-09-18 968/week @ 2024-09-25 671/week @ 2024-10-02 642/week @ 2024-10-09 630/week @ 2024-10-16 730/week @ 2024-10-23 666/week @ 2024-10-30 804/week @ 2024-11-06 608/week @ 2024-11-13 264/week @ 2024-11-20 156/week @ 2024-11-27 392/week @ 2024-12-04 401/week @ 2024-12-11 311/week @ 2024-12-18

1,283 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

~4–6MB
~103K SLoC