npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

thanks-contributors

v1.0.3

Published

This little script accesses GitHub's API to get all contributors and their PRs between two distinct points in the history of commits. This is helpful for changelogs where you'd want to list all contributions for that release (so e.g. changes between v1 an

Downloads

14

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

lekoartslekoarts

Keywords

thanks-contributorschangelogrelease notescontributorslist of PRs

Readme

Thanks Contributors!

This little script accesses GitHub's API to get all contributors and their PRs between two distinct points in the history of commits. This is helpful for changelogs where you'd want to list all contributions for that release (so e.g. changes between v1 and v1.1).

Usage

npx thanks-contributors <base> <head> [owner] [repo]

First it get's the list of commits between base...head (equivalent to git log
base..head), then parses their authors out and creates a markdown list of each
contributor and their contribution. By default it excludes the members of the
(owner) organization. Saves the result into an "output" folder.

Positionals:
  base                                                                  [string]
  head                                                                  [string]
  owner                                          [string] [Standard: "gatsbyjs"]
  repo                                             [string] [Standard: "gatsby"]

Optionen:
      --version            Show version                                [boolean]
  -h, --help               Show help                                   [boolean]
  -l, --useListCommitsAPI  Use the "List commits" API
                           (https://docs.github.com/en/free-pro-team@latest/rest
                           /reference/repos#list-commits) instead of the
                           "Compare two commits" API
                           (https://docs.github.com/en/free-pro-team@latest/rest
                           /reference/repos#compare-two-commits)
                                                     [boolean] [Standard: false]
  -i, --include            Whether to include organization members from the list
                           or not                    [boolean] [Standard: false]

You must have an environment variable called GITHUB_ACCESS_TOKEN either exported in your CLI or defined inside an .env file in the root of the project.

The script automatically excludes the members of the organization ("owner" in this case). If you want to exclude specific users, you'll need to edit the index.js (at the moment).

The results are stored inside a ./output folder.

Example

npx thanks-contributors [email protected] [email protected] gatsbyjs gatsby

Resulting output

It'll create a markdown list, grouped by user login. If a person had more than one commit, it creates a nested list. Example:

- [harry](https://www.github.com/harry): Update something [PR #1](https://github.com/foobar/pull/1)
- [hermione](https://www.github.com/hermione)
  - Update something [PR #2](https://github.com/foobar/pull/2)
  - Update something more [PR #3](https://github.com/foobar/pull/3)

If the url can't be found only the name will be printed.

Caveats

  • Getting the PR number only works if you consistently add the number in the commit itself, e.g. in feat: My cool feature (#123). This automatically happens in GitHub's UI if you use squash commits.
  • The excludes currently can't be defined manually via the CLI