Skip to content
This repository has been archived by the owner on Jan 12, 2021. It is now read-only.

Commit

Permalink
docs: update issue/pr templates (#60)
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Nester <steve.nester@bugsnag.com>
  • Loading branch information
steve-nester-uk and Steve Nester committed Sep 1, 2020
1 parent 7079744 commit 4606c88
Show file tree
Hide file tree
Showing 6 changed files with 122 additions and 18 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/A.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Having trouble getting started?
about: Please contact us at support@bugsnag.com for assistance with integrating Bugsnag
into your application.
title: ''
labels: ''
assignees: ''

---
Please checkout our [documentation](https://docs.bugsnag.com/build-integrations/js/#uploading-source-maps) for guides, references and tutorials.

If you have questions about your integration please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).

Alternatively, view additional options at [support.md](../SUPPORT.md).
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Bug report
about: Create a report to help us improve the library
title: ''
labels: ''
assignees: ''

---

<!-- Before raising, please check if somebody else has already reported your issue. -->

### Describe the bug
A clear and concise description of what the bug is.

### Steps to reproduce
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Environment
* Node version:
* NPM version:

<!--
Below are a few approaches you might take to communicate the issue, in
descending order of awesomeness. Please choose one and feel free to delete
the others from this template.
-->

### Example Repo <!-- Option 1 -->

- [ ] Create a minimal repository that can reproduce the issue
- [ ] Link to it here:

### Example code snippet <!-- Option 2 -->

```
# (Insert code sample to reproduce the problem)
```

<!-- Error messages, if any -->
<details><summary>Error messages:</summary>

```
```
</details>
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: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

<!-- Before creating, please check if somebody else has already reported your feature request. -->

### Description
<!-- Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-->

**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
<!--Add any other context about the feature request here.-->
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Goal

<!-- Why is this change necessary? -->

## Design

<!-- Why was this approach used? -->

## Changeset

<!-- What changed? -->

## Testing

<!-- How was it tested? What manual and automated tests were
run/added? -->
20 changes: 20 additions & 0 deletions .github/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Are you having trouble getting started?
If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/build-integrations/js/#uploading-source-maps) for guides, references and tutorials.

Or, if you wish you can [contact us directly](mailto:support@bugsnag.com) for assistance on integrating Bugsnag into your application, troubleshooting an issue or a question about our supported features.

When contacting support, please include as much information as necessary, including:

- example code snippet
- steps to reproduce
- expected/actual behaviour

* Node version:
* NPM version:

## Bug or Feature Requests
If you would like to raise a bug or feature request please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-sourcemaps/issues/new/choose) and selecting bug or feature.
Please note: we cannot promise that we will fulfil all requests

## Pull Requests
If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../CONTRIBUTING.md) file before creating the pull request.
18 changes: 0 additions & 18 deletions issue_template.md

This file was deleted.

0 comments on commit 4606c88

Please sign in to comment.