mrm-task-contributing/Readme.md

Mrm task that adds contributing guidelines

<!-- Contributing guidelines -->

# mrm-task-contributing

[Mrm](https://github.com/sapegin/mrm) task that adds contributing guidelines.

## What it does

- Creates a contributing guidelines file

## Usage

```
npx mrm contributing
```

## Options

See [Mrm docs](../../docs/Getting_started.md) 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](CHANGELOG.md).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](../../Contributing.md).

## Authors and license

[Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/sapegin/mrm/graphs/contributors).

MIT License, see the included [License.md](License.md) file.