Skip to content

Commit

Permalink
Make README intro more succinct (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanv committed Nov 29, 2023
1 parent 6164346 commit c982713
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# changelist

Changelist helps you write better release notes by automating as much of the
process as possible. For example, see
A tool that automates release note generation.

For example, see
https://github.com/scientific-python/changelist/blob/main/CHANGELOG.md.

**Features**

- Compile a list of pull requests, code authors and reviewers between any two
valid Git objects (refs).
- Compile a list of pull requests, code authors, and reviewers between
two given git commits.
- Categorize pull requests into sections based on GitHub labels.
- Point it at any repository on GitHub. No need to clone or checkout a
repository locally, a Python package is all that's needed.

We recommend to treat the generated document as a first draft to build
on and not as an already perfect documentation of the release.

_This project is currently in its alpha stage and might be incomplete or change a lot!_

Expand Down

0 comments on commit c982713

Please sign in to comment.