Skip to content

Commit

Permalink
docs: add tentative issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed May 18, 2020
1 parent 99476af commit 64ae398
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug Report
about: Report a bug
title: ''
labels: bug
assignees: ''
---

## Expected behavior
<!-- Provide a detailed description of how you expected the software to -->
<!-- behave. -->

## Actual behavior
<!-- Provide a detailed description of how the software actually behaved, -->
<!-- including any rationale for why that behavior is incorrect. -->

## ESLint Config

<!-- What is the minimal config that reproduces the issue? -->

## ESLint sample

<!-- What code triggers the error? -->

```js
// Format code using Markdown code blocks
```

<!-- OR, if this is not triggered by a single rule, what is the
problem and how can one reproduce? -->

## Environment

* Node version: <!-- $ node -v -->
* ESLint version <!-- $ $(npm bin)/eslint -v -->
* `eslint-plugin-jsdoc` version:
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature Request
about: Report a new feature
title: ''
labels: enhancement
assignees: ''
---

## Motivation

<!-- What would be the purpose of this new feature? -->

## Current behavior

<!-- If this is to enhance an existing rule, how does the rule
currently behave in regard to the new changes? -->

## Desired behavior

<!-- What would you like to see happen instead? -->

## Alternatives considered

<!-- For any alternatives you have considered -->
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ package-lock.json
!.README
!.travis.yml
!.ncurc.js
!.github

0 comments on commit 64ae398

Please sign in to comment.