/helper-issue

Helper to create a URL that pre-populates a Github issue.

Primary LanguageJavaScriptMIT LicenseMIT

helper-issue NPM version Build Status

Helper to create a URL that pre-populates a Github issue.

Install with npm

$ npm i helper-issue --save

Usage

var issue = require('helper-issue');

API

issue

Helper to create a URL that pre-populates a Github issue.

Params

  • repository {String|Object}: Repository string or object.
  • data {Object}: Data object to add as query parameters to the generated URL.
  • data.title {String}: Short string to populate the github issue title field.
  • data.body {String}: Markdown string to populate the github issue body field.
  • returns {String}: URL that can be used in an anchor tag.

Example

var url = issue('helpers/helper-issue', {
  title: 'Issue Title',
  body: 'Issue body that may contain markdown'
});
//=> https://github.com/helper/helper-issue/issues/new?title=Issue%20Title&body=Issue%20body%20that%20may%20contain%20markdown

Related projects

parse-github-url: Parse a github URL into an object. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Author

Brian Woodward

License

Copyright © 2015 Brian Woodward Released under the MIT license.

This file was generated by verb on December 22, 2015.