{"id":13684378,"url":"https://github.com/hanneskaeufler/danger-plugin-mentor","last_synced_at":"2025-03-12T14:31:32.739Z","repository":{"id":28770231,"uuid":"119281590","full_name":"hanneskaeufler/danger-plugin-mentor","owner":"hanneskaeufler","description":"A http://danger.systems/js plugin to level up with each pull request.","archived":true,"fork":false,"pushed_at":"2023-03-27T10:58:58.000Z","size":1244,"stargazers_count":9,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-25T02:04:58.419Z","etag":null,"topics":["automated-code-review","danger","danger-js","danger-plugin","learning","mentoring","mentorship"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hanneskaeufler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-28T17:34:32.000Z","updated_at":"2024-10-04T20:08:23.000Z","dependencies_parsed_at":"2024-06-20T18:58:29.306Z","dependency_job_id":null,"html_url":"https://github.com/hanneskaeufler/danger-plugin-mentor","commit_stats":{"total_commits":298,"total_committers":9,"mean_commits":"33.111111111111114","dds":0.610738255033557,"last_synced_commit":"2ea987f19a61915cf18be24d731db5a3000dec65"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanneskaeufler%2Fdanger-plugin-mentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanneskaeufler%2Fdanger-plugin-mentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanneskaeufler%2Fdanger-plugin-mentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hanneskaeufler%2Fdanger-plugin-mentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hanneskaeufler","download_url":"https://codeload.github.com/hanneskaeufler/danger-plugin-mentor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243234631,"owners_count":20258500,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automated-code-review","danger","danger-js","danger-plugin","learning","mentoring","mentorship"],"created_at":"2024-08-02T14:00:32.904Z","updated_at":"2025-03-12T14:31:32.328Z","avatar_url":"https://github.com/hanneskaeufler.png","language":"TypeScript","funding_links":[],"categories":["Plugins"],"sub_categories":["TypeScript (danger-js)"],"readme":"# danger-plugin-mentor\n\n[![Build Status](https://travis-ci.org/hanneskaeufler/danger-plugin-mentor.svg?branch=master)](https://travis-ci.org/hanneskaeufler/danger-plugin-mentor)\n[![npm version](https://badge.fury.io/js/danger-plugin-mentor.svg)](https://badge.fury.io/js/danger-plugin-mentor)\n[![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)\n[![Maintainability](https://api.codeclimate.com/v1/badges/08c3ff10e169f93aa50c/maintainability)](https://codeclimate.com/github/hanneskaeufler/danger-plugin-mentor/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/08c3ff10e169f93aa50c/test_coverage)](https://codeclimate.com/github/hanneskaeufler/danger-plugin-mentor/test_coverage) \n\n\u003e Level up your programming skills by getting bite-sized tips and tricks in your pull requests.\n\n## Usage\n\nInstall:\n\n```sh\nyarn add danger-plugin-mentor --dev\n```\n\nAt a glance:\n\n```js\n// dangerfile.js\nimport mentor from 'danger-plugin-mentor'\n\nmentor()\n```\n\n![example](example.png)\n\nYou can specify an array of string tags to filter the shown tips:\n\n```js\nmentor([\"testing\", \"agile\"])\n```\n\nShould you not like or want to expand upon the default set of tips, you can pass an array of tips that you provide yourself.\n\n```js\nmentor([], myOwnListOfTips)\n```\n\nThe items in `myOwnListOfTips` have to conform to the `Tip` [interface](src/tip.ts), that,\nin Typescript, you can import via `import { Tip } from 'danger-plugin-mentor'`.\nIn Javascript, you just need to make sure that every item responds to the methods\nof this interface. Of course you can mix your own tips with the included tips:\n\n```js\nimport { default as mentor, defaultTips } from 'danger-plugin-mentor'\n\nmentor([], [...defaultTips(), ...myOwnListOfTips])\n```\n\nIn order to make it easy to provide your own list of tips, danger-plugin-mentor ships\nwith a `fromJson` that returns an array of lists from a json file.\n\n```js\nimport { default as mentor, fromJson } from \"danger-plugin-mentor\"\n\nmentor([], fromJson(`\n[\n    {\n        \"text\": \"My own tip\",\n        \"source\": \"https://mycompany.com\",\n        \"tags\": [\"awesome\"]\n    }\n]\n`))\n\n```\n\n## Changelog\n\nSee the GitHub [release history](https://github.com/hanneskaeufler/danger-plugin-mentor/releases).\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanneskaeufler%2Fdanger-plugin-mentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhanneskaeufler%2Fdanger-plugin-mentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhanneskaeufler%2Fdanger-plugin-mentor/lists"}