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

keep-a-changelog

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

1 unstable release

0.1.0 Apr 28, 2024

#484 in Development tools

Download history 108/week @ 2024-04-22 48/week @ 2024-04-29

156 downloads per month

MIT license

42KB
783 lines

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
~118K SLoC