Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@auto-it/all-contributors

Package Overview
Dependencies
Maintainers
1
Versions
698
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@auto-it/all-contributors

Automatically add contributors as changelogs are produced.

  • 7.13.0-canary.658.8501.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
7.8K
decreased by-29.86%
Maintainers
1
Weekly downloads
 
Created
Source

All Contributors Plugin

Automatically add contributors as changelogs are produced.

This plugin maps one of the contribution type to a glob or array of globs. Out of the box the plugin will only detect the following contribution types:

  • 📖 doc - Edits to any README, `['/*.mdx', '/.md', '/docs//', '/documentation//*']``
  • 💡 example - Edits to ['**/*.stories*', '**/*.story.*']
  • 🚇 infra - Edits to ['**/.circle/**/*', '**/.github/**/*', '**/travis.yml'],
  • ⚠️ test - Edits to ['**/*.test.*']
  • 💻 code - Edits to ['**/src/**/*', '**/lib/**/*', '**/package.json', '**/tsconfig.json']

Installation

This plugin is not included with the auto CLI installed via NPM. To install:

npx install-peerdeps --dev @auto-it/all-contributors

Prerequisites

You must have already installed and initialized all-contributors-cli;

npx all-contributors init

Usage

{
  "plugins": ["all-contributors"]
}

Configure Contribution Type Matching

You use any of the contribution type. If you configure an pre-configured contribution type the arrays are not merged, it is overridden.

auto.rc

{
  "plugins": [
    [
      "all-contributors",
      {
        "types": {
          "plugin": "**/plugin/**/*",
          "example": ["**/*.stories.*", "**/*.examples.*", "**/*.snippet.*"]
        }
      }
    ]
  ]
}

Exclude Users

Useful for excluding bots from getting into your contributors.

auto.rc

{
  "plugins": [
    [
      "all-contributors",
      {
        "exclude": ["dependabot", "ci-services"]
      }
    ]
  ]
}

Keywords

FAQs

Package last updated on 06 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc