https://github.com/hanneskaeufler/danger-plugin-mentor

A http://danger.systems/js plugin to level up with each pull request.
https://github.com/hanneskaeufler/danger-plugin-mentor

automated-code-review danger danger-js danger-plugin learning mentoring mentorship

Last synced: 4 months ago
JSON representation

A http://danger.systems/js plugin to level up with each pull request.

• Host: GitHub
• URL: https://github.com/hanneskaeufler/danger-plugin-mentor
• Owner: hanneskaeufler
• License: mit
• Created: 2018-01-28T17:34:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T10:58:58.000Z (about 1 year ago)
• Last Synced: 2024-02-12T05:44:34.161Z (4 months ago)
• Topics: automated-code-review, danger, danger-js, danger-plugin, learning, mentoring, mentorship
• Language: TypeScript
• Homepage:
• Size: 1.19 MB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-danger - danger-plugin-mentor - A Danger plugin to level up with each pull request. (Plugins / TypeScript (danger-js))

README

        
# danger-plugin-mentor

[![Build Status](https://travis-ci.org/hanneskaeufler/danger-plugin-mentor.svg?branch=master)](https://travis-ci.org/hanneskaeufler/danger-plugin-mentor)

[![npm version](https://badge.fury.io/js/danger-plugin-mentor.svg)](https://badge.fury.io/js/danger-plugin-mentor)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Maintainability](https://api.codeclimate.com/v1/badges/08c3ff10e169f93aa50c/maintainability)](https://codeclimate.com/github/hanneskaeufler/danger-plugin-mentor/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/08c3ff10e169f93aa50c/test_coverage)](https://codeclimate.com/github/hanneskaeufler/danger-plugin-mentor/test_coverage) 

> Level up your programming skills by getting bite-sized tips and tricks in your pull requests.

## Usage

Install:

```sh

yarn add danger-plugin-mentor --dev

```

At a glance:

```js

// dangerfile.js

import mentor from 'danger-plugin-mentor'

mentor()

```

![example](example.png)

You can specify an array of string tags to filter the shown tips:

```js

mentor(["testing", "agile"])

```

Should you not like or want to expand upon the default set of tips, you can pass an array of tips that you provide yourself.

```js

mentor([], myOwnListOfTips)

```

The items in `myOwnListOfTips` have to conform to the `Tip` [interface](src/tip.ts), that,

in Typescript, you can import via `import { Tip } from 'danger-plugin-mentor'`.

In Javascript, you just need to make sure that every item responds to the methods

of this interface. Of course you can mix your own tips with the included tips:

```js

import { default as mentor, defaultTips } from 'danger-plugin-mentor'

mentor([], [...defaultTips(), ...myOwnListOfTips])

```

In order to make it easy to provide your own list of tips, danger-plugin-mentor ships

with a `fromJson` that returns an array of lists from a json file.

```js

import { default as mentor, fromJson } from "danger-plugin-mentor"

mentor([], fromJson(`

[

    {

        "text": "My own tip",

        "source": "https://mycompany.com",

        "tags": ["awesome"]

    }

]

`))

```

## Changelog

See the GitHub [release history](https://github.com/hanneskaeufler/danger-plugin-mentor/releases).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).