mrm-task-contributing

Mrm task that adds contributing guidelines

Usage no npm install needed!

<script type="module">
  import mrmTaskContributing from 'https://cdn.skypack.dev/mrm-task-contributing';
</script>

README

mrm-task-contributing

Mrm task that adds contributing guidelines.

What it does

  • Creates a contributing guidelines file

Usage

npx mrm contributing

Options

See Mrm docs for more details.

github (default: extracted from .git/config file)

Your GitHub user name.

contributingFile (default: Contributing.md)

Name of the contributing guidelines file.

packageName (default: name field in package.json)

Package name.

Changelog

The changelog can be found in CHANGELOG.md.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.