Skip to content
This repository was archived by the owner on Sep 14, 2020. It is now read-only.

Commit 3f74b34

Browse files
fractalwrenchfractalwrench
authored
Merge branch 'master' into api-key-plist-fix
2 parents 3ec0fb8 + e5e31a1 commit 3f74b34

7 files changed

Lines changed: 244 additions & 59 deletions

File tree

‎.github/ISSUE_TEMPLATE/A.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Having trouble getting started?
3+
about: Please contact us at support@bugsnag.com for assistance with integrating Bugsnag
4+
into your application.
5+
6+
---
7+
8+
<!--
9+
10+
Are you having trouble getting started? Please contact us directly at support@bugsnag.com for assistance with integrating Bugsnag into your application.
11+
12+
-->

issue_template.md renamed to .github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 65 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,65 @@
1-
### Description
2-
<!-- A quick description of what you're trying to accomplish -->
3-
4-
### Issue
5-
<!--
6-
What went wrong? (If this issue is a general question or a proposed change,
7-
feel free to delete this and subsequent sections.
8-
-->
9-
10-
### Environment
11-
12-
Library versions:
13-
14-
<!--
15-
Paste the output of this command into the code block below (use `npm ls`
16-
instead of `yarn list` if you are using npm):
17-
yarn list react-native bugsnag-react-native react-native-code-push
18-
-->
19-
```shell
20-
21-
```
22-
23-
- cocoapods version (if any) (`pod -v`):
24-
- iOS/Android version(s):
25-
- simulator/emulator or physical device?:
26-
- debug mode or production?:
27-
28-
- [ ] (iOS only) `[BugsnagReactNative start]` is present in the
29-
`application:didFinishLaunchingWithOptions:` method in your `AppDelegate`
30-
class?
31-
- [ ] (Android only) `BugsnagReactNative.start(this)` is present in the
32-
`onCreate` method of your `MainApplication` class?
33-
34-
35-
<!--
36-
Below are a few approaches you might take to communicate the issue, in
37-
descending order of awesomeness. Please choose one and feel free to delete
38-
the others from this template.
39-
-->
40-
### Example Repo
41-
42-
- [ ] Create a minimal repository that can reproduce the issue after running
43-
`yarn install` and `react-native run-ios`/`react-native run-android`
44-
- [ ] Link to it here:
45-
46-
### Example code snippet
47-
48-
```js
49-
import { Client, Configuration } from 'bugsnag-react-native';
50-
51-
// (Insert code sample to reproduce the problem)
52-
```
53-
54-
<!-- Error messages, if any -->
55-
```
56-
57-
```
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve the library
4+
5+
---
6+
7+
### Description
8+
<!-- A quick description of what you're trying to accomplish -->
9+
10+
### Issue
11+
<!--
12+
What went wrong?
13+
-->
14+
15+
### Environment
16+
17+
Library versions:
18+
19+
<!--
20+
Paste the output of this command into the code block below (use `npm ls`
21+
instead of `yarn list` if you are using npm):
22+
yarn list react-native bugsnag-react-native react-native-code-push
23+
-->
24+
```shell
25+
26+
```
27+
28+
- cocoapods version (if any) (`pod -v`):
29+
- iOS/Android version(s):
30+
- simulator/emulator or physical device?:
31+
- debug mode or production?:
32+
33+
- [ ] (iOS only) `[BugsnagReactNative start]` is present in the
34+
`application:didFinishLaunchingWithOptions:` method in your `AppDelegate`
35+
class?
36+
- [ ] (Android only) `BugsnagReactNative.start(this)` is present in the
37+
`onCreate` method of your `MainApplication` class?
38+
39+
40+
<!--
41+
Below are a few approaches you might take to communicate the issue, in
42+
descending order of awesomeness. Please choose one and feel free to delete
43+
the others from this template.
44+
-->
45+
### Example Repo
46+
47+
- [ ] Create a minimal repository that can reproduce the issue after running
48+
`yarn install` and `react-native run-ios`/`react-native run-android`
49+
- [ ] Link to it here:
50+
51+
### Example code snippet
52+
53+
```js
54+
import { Client, Configuration } from 'bugsnag-react-native';
55+
56+
// (Insert code sample to reproduce the problem)
57+
```
58+
59+
<!-- Error messages, if any -->
60+
<details><summary>Error messages:</summary>
61+
62+
```
63+
64+
```
65+
</details>

‎.github/ISSUE_TEMPLATE/Feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
### Description
8+
<!-- Is your feature request related to a problem? Please describe.
9+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
-->
11+
12+
**Describe the solution you'd like**
13+
<!-- A clear and concise description of what you want to happen. -->
14+
15+
**Describe alternatives you've considered**
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
17+
18+
**Additional context**
19+
Add any other context about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
## Goal
2+
3+
<!-- What is the intent of this change?
4+
e.g. "When initializing the Bugsnag client, it is currently difficult to (...)
5+
this change simplifies the process by (...)"
6+
7+
"Improves the performance of data filtering"
8+
9+
"Adds additional test coverage to multi-threaded use of Configuration
10+
objects"
11+
-->
12+
13+
<!-- For new features, include design documentation:
14+
15+
## Design
16+
17+
Why was this approach to the goal used?
18+
19+
-->
20+
21+
## Changeset
22+
23+
<!-- What structures or properties or functions were:
24+
25+
### Added
26+
27+
### Removed
28+
29+
### Changed
30+
31+
-->
32+
33+
## Tests
34+
35+
<!-- How was this change tested? What manual and automated tests were
36+
run/added? -->
37+
38+
## Discussion
39+
40+
### Alternative Approaches
41+
42+
<!-- What other approaches were considered or discussed? -->
43+
44+
### Outstanding Questions
45+
46+
<!-- Are there any parts of the design or the implementation which seem
47+
less than ideal and that could require additional discussion?
48+
List here: -->
49+
50+
### Linked issues
51+
52+
<!--
53+
54+
Fixes #
55+
Related to #
56+
57+
-->
58+
59+
## Review
60+
61+
<!-- When submitting for review, consider the points for self-review and the
62+
criteria which will be used for secondary review -->
63+
64+
For the submitter, initial self-review:
65+
66+
- [ ] Commented on code changes inline explain the reasoning behind the approach
67+
- [ ] Reviewed the test cases added for completeness and possible points for discussion
68+
- [ ] A changelog entry was added for the goal of this pull request
69+
- [ ] Check the scope of the changeset - is everything in the diff required for the pull request?
70+
- This pull request is ready for:
71+
- [ ] Initial review of the intended approach, not yet feature complete
72+
- [ ] Structural review of the classes, functions, and properties modified
73+
- [ ] Final review
74+
75+
For the pull request reviewer(s), this changeset has been reviewed for:
76+
77+
- [ ] Consistency across platforms for structures or concepts added or modified
78+
- [ ] Consistency between the changeset and the goal stated above
79+
- [ ] Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added?
80+
- [ ] Usage friction - is the proposed change in usage cumbersome or complicated?
81+
- [ ] Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc?
82+
- [ ] Concurrency concerns - if components are accessed asynchronously, what issues will arise
83+
- [ ] Thoroughness of added tests and any missing edge cases
84+
- [ ] Idiomatic use of the language

‎.github/SUPPORT.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Are you having trouble getting started?
2+
Please [contact us directly](mailto:support@bugsnag.com) for assistance with integrating Bugsnag into your application.
3+
4+
Include the following information to help us understand your environment:
5+
6+
### Library versions
7+
8+
Paste the output of this command into the code block below (use `npm ls` instead
9+
of `yarn list` if you are using npm):
10+
11+
```
12+
yarn list react-native bugsnag-react-native react-native-code-push
13+
```
14+
15+
- cocoapods version (if any) (`pod -v`):
16+
- iOS/Android version(s):
17+
- simulator/emulator or physical device?:
18+
- debug mode or production?:
19+
20+
- [ ] (iOS only) `[BugsnagReactNative start]` is present in the
21+
`application:didFinishLaunchingWithOptions:` method in your `AppDelegate`
22+
class?
23+
- [ ] (Android only) `BugsnagReactNative.start(this)` is present in the
24+
`onCreate` method of your `MainApplication` class?

‎CONTRIBUTING.md‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,47 @@
11
# Contributing
22

3+
Thanks for stopping by! This document should cover most topics surrounding contributing to `bugsnag-react-native`.
4+
5+
* [How to contribute](#how-to-contribute)
6+
* [Reporting issues](#reporting-issues)
7+
* [Fixing issues](#fixing-issues)
8+
* [Adding features](#adding-features)
9+
* [Building](#building)
10+
* [Testing](#testing)
11+
12+
13+
## Reporting issues
14+
15+
Are you having trouble getting started? Please [contact us directly](mailto:support@bugsnag.com) for assistance with integrating Bugsnag into your application.
16+
If you have spotted a problem with this module, feel free to open a [new issue](https://github.com/bugsnag/bugsnag-react-native/issues/new?template=Bug_report.md). Here are a few things to check before doing so:
17+
18+
* Are you using the latest version of `bugsnag-react-native`? If not, does updating to the latest version fix your issue?
19+
* Has somebody else [already reported](https://github.com/bugsnag/bugsnag-react-native/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen) your issue? Feel free to add additional context to or check-in on an existing issue that matches your own.
20+
* Is your issue caused by this module? Only things related to the `bugsnag-react-native` module should be reported here. For anything else, please [contact us directly](mailto:support@bugsnag.com) and we'd be happy to help you out.
21+
22+
### Fixing issues
23+
24+
If you've identified a fix to a new or existing issue, we welcome contributions!
25+
Here are some helpful suggestions on contributing that help us merge your PR quickly and smoothly:
26+
327
* [Fork](https://help.github.com/articles/fork-a-repo) the
428
[library on GitHub](https://github.com/bugsnag/bugsnag-react-native)
5-
* Build and test your changes
29+
* Build and test your changes. We have automated tests for many scenarios but its also helpful to use `npm pack` to build the module locally and install it in a real app.
630
* Commit and push until you are happy with your contribution
731
* [Make a pull request](https://help.github.com/articles/using-pull-requests)
32+
* Ensure the automated checks pass (and if it fails, please try to address the cause)
33+
34+
### Adding features
35+
36+
Unfortunately we’re unable to accept PRs that add features or refactor the library at this time.
37+
However, we’re very eager and welcome to hearing feedback about the library so please contact us directly to discuss your idea, or open a
38+
[feature request](https://github.com/bugsnag/bugsnag-react-native/issues/new?template=Feature_request.md) to help us improve the library.
39+
40+
Here’s a bit about our process designing and building the Bugsnag libraries:
41+
42+
* We have an internal roadmap to plan out the features we build, and sometimes we will already be planning your suggested feature!
43+
* Our open source libraries span many languages and frameworks so we strive to ensure they are idiomatic on the given platform, but also consistent in terminology between platforms. That way the core concepts are familiar whether you adopt Bugsnag for one platform or many.
44+
* Finally, one of our goals is to ensure our libraries work reliably, even in crashy, multi-threaded environments. Oftentimes, this requires an intensive engineering design and code review process that adheres to our style and linting guidelines.
845

946

1047
## Building

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ Automatic [React Native crash reporting](https://www.bugsnag.com/platforms/react
2424

2525
* [Read the integration guide](https://docs.bugsnag.com/platforms/react-native/) or [configuration options documentation](https://docs.bugsnag.com/platforms/react-native/configuration-options/)
2626
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-react-native/issues?utf8=✓&q=is%3Aissue) for similar problems
27-
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-react-native/issues/new)
27+
* Having trouble getting started? Please [contact support](mailto:support@bugsnag.com)
28+
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-react-native/issues/new/choose)
2829

2930

3031
## Contributing

0 commit comments

Comments
 (0)