yoshuawuyts/changelog

Add information from GitHub

Open

#8 opened on Aug 28, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (4 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (86 stars)
PR merge metrics
 (PR metrics pending)

Description

Feature Request

Summary

We should query GitHub to provide richer changelog information.

Motivation

Most discussions about code happen on github. issues are created, people create pull-requests. Comments are made. Including data from GitHub allows us to document more of the changes made, and provides more of a reference of the changes that occurred.

Expected Behavior

I'd like to see the following features:

  • one-time login using https://github.com/yoshuawuyts/github_auth
  • include github usernames instead of emails to attribute committers
  • always include a link to the PR that a commit was introduced in
  • create a new section for first-time committers to thank them for their contributions
  • include a section linking to issues that were closed since the last release
  • include a section with known bugs linking to all issues marked bug

Drawbacks

This assumes folks have a GitHub account. Which is probably an okay assumption since it's also a requirement for Cargo. Perhaps we could keep a legacy mode that only fetches information from git. But I'm so-so about that.

Rationale and alternatives

It only relies on information that is statically retrievable, while further integrating itself with known tools out there. Alternatively we could construct most of this info from local git only, but it misses a lot of crucial information.

Unresolved Questions

None at this time. GitHub login is already accounted for, and most of the other questions I think would arise during implementation. Probably hubcaps is the right way to integrate with GitHub.

Contributor guide