@rmtc/plugin-contributing NPM

@rmtc/plugin-contributing

A plugin for @rmtc/toolchain that syncs contributing and code of conduct documents to ensure they're consistent across projects.

!WARNING This project is intended for use in @rowanmanning's projects. It's free to use but I don't offer support for use-cases outside of what I need.

Requirements

This library requires the following to run:

Usage

Install the module with npm:

npm install --save-dev @rmtc/plugin-contributing

Include it in your .rmtc.json file:

{
    plugins: [
        // ...
        '@rmtc/plugin-contributing'
    ]
    // ...
}

Workflows

This plugin defines the following workflows:

postinstall: a general workflow used to indicate steps that should be run after dependencies have been installed.

Steps

This plugin defines the following steps that can be added to any workflow:

contributing:install: override the docs/contributing.md and docs/code_of_conduct.md files in the project folder, ensuring that they're consistent.

Configuration

`config.techSections`

string[]. Use this configuration to add additional sections to the end of the contributing guide which may not apply to all projects. The following sections are available: conventional-commits, linting, testing, and types-in-jsdoc. E.g.

{
    plugins: [
        ['@rmtc/plugin-contributing', {
            techSections: [
                'conventional-commits',
                'linting',
                'types-in-jsdoc',
                'testing'
            ]
        }]
    ]
}

The ordering of these sections will be matched in the generated document.