-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #628 from bugsnag/SUP-34---github-templates
SUP-34 GitHub templates
Showing
7 changed files
with
129 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/platforms/ruby/) 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
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 | ||
* Bugsnag version: | ||
* Ruby version: | ||
* Bundle version: | ||
* Integration framework version: | ||
* Que: | ||
* Rack | ||
* Rails: | ||
* Rake: | ||
* Sidekiq: | ||
* Other: | ||
|
||
<!-- | ||
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,16 @@ | ||
## Goal | ||
|
||
<!-- What is the intent of this change? | ||
e.g. "When initializing the Bugsnag client, it is currently difficult to (...) | ||
this change simplifies the process by (...)" | ||
"Improves the performance of data filtering" | ||
"Adds additional test coverage to multi-threaded use of Configuration | ||
objects" | ||
--> | ||
|
||
<!-- For new features, include design documentation: | ||
<!-- Why is this change necessary? --> | ||
|
||
## Design | ||
|
||
Why was this approach to the goal used? | ||
--> | ||
<!-- Why was this approach used? --> | ||
|
||
## Changeset | ||
|
||
<!-- What structures or properties or functions were: | ||
### Added | ||
### Removed | ||
### Changed | ||
--> | ||
|
||
## Tests | ||
|
||
<!-- How was this change tested? What manual and automated tests were | ||
run/added? --> | ||
|
||
## Discussion | ||
|
||
### Alternative Approaches | ||
|
||
<!-- What other approaches were considered or discussed? --> | ||
|
||
### Outstanding Questions | ||
|
||
<!-- Are there any parts of the design or the implementation which seem | ||
less than ideal and that could require additional discussion? | ||
List here: --> | ||
|
||
### Linked issues | ||
|
||
<!-- | ||
Fixes # | ||
Related to # | ||
--> | ||
|
||
## Review | ||
|
||
<!-- When submitting for review, consider the points for self-review and the | ||
criteria which will be used for secondary review --> | ||
|
||
For the submitter, initial self-review: | ||
|
||
- [ ] Commented on code changes inline explain the reasoning behind the approach | ||
- [ ] Reviewed the test cases added for completeness and possible points for discussion | ||
- [ ] A changelog entry was added for the goal of this pull request | ||
- [ ] Check the scope of the changeset - is everything in the diff required for the pull request? | ||
- This pull request is ready for: | ||
- [ ] Initial review of the intended approach, not yet feature complete | ||
- [ ] Structural review of the classes, functions, and properties modified | ||
- [ ] Final review | ||
<!-- What changed? --> | ||
|
||
For the pull request reviewer(s), this changeset has been reviewed for: | ||
## Testing | ||
|
||
- [ ] Consistency across platforms for structures or concepts added or modified | ||
- [ ] Consistency between the changeset and the goal stated above | ||
- [ ] Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added? | ||
- [ ] Usage friction - is the proposed change in usage cumbersome or complicated? | ||
- [ ] Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc? | ||
- [ ] Concurrency concerns - if components are accessed asynchronously, what issues will arise | ||
- [ ] Thoroughness of added tests and any missing edge cases | ||
- [ ] Idiomatic use of the language | ||
<!-- How was it tested? What manual and automated tests were | ||
run/added? --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
## Are you having trouble getting started? | ||
If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/platforms/ruby/) 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 | ||
|
||
* Bugsnag version: | ||
* Ruby version: | ||
* Bundle version: | ||
* Integration framework version: | ||
* Que: | ||
* Rack | ||
* Rails: | ||
* Rake: | ||
* Sidekiq: | ||
* Other: | ||
|
||
## 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-ruby/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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.