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

Commit e5e31a1

Browse files
committed
chore: Make contributing guidelines clearer
1 parent f3d681a commit e5e31a1

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,39 @@ Thanks for stopping by! This document should cover most topics surrounding contr
99
* [Building](#building)
1010
* [Testing](#testing)
1111

12-
12+
1313
## Reporting issues
1414

1515
Are you having trouble getting started? Please [contact us directly](mailto:support@bugsnag.com) for assistance with integrating Bugsnag into your application.
16-
17-
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). There are a few things to check before doing so:
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:
1817

1918
* Are you using the latest version of `bugsnag-react-native`? If not, does updating to the latest version fix your issue?
2019
* 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.
21-
* Is your issue caused by this module? Only things related to the `bugsnag-react-native` module should be reported here. For anything else [contact us directly](mailto:support@bugsnag.com).
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.
2221

2322
### Fixing issues
2423

25-
If you've identified a fix to a new or existing issue, we welcome contributions!
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:
2626

2727
* [Fork](https://help.github.com/articles/fork-a-repo) the
2828
[library on GitHub](https://github.com/bugsnag/bugsnag-react-native)
2929
* 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.
3030
* Commit and push until you are happy with your contribution
3131
* [Make a pull request](https://help.github.com/articles/using-pull-requests)
32-
* Ensure the automated checks pass (and if it fails, attempt to address the cause)
32+
* Ensure the automated checks pass (and if it fails, please try to address the cause)
3333

3434
### Adding features
3535

36-
In general, feature additions will come from Bugsnag employees. If you have an idea for a useful addition to the library, please [contact us directly](mailto:support@bugsnag.com) or [open a feature request](https://github.com/bugsnag/bugsnag-react-native/issues/new?template=Feature_request.md) so that we can discuss how to make the library better. Pull requests which add new features or refactor the library are unlikely to be merged because:
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.
3739

38-
1. Bugsnag has an internal roadmap of things to work on next, and we have potentially already planned your suggested feature.
39-
2. Bugsnag builds libraries with the goal of being both idiomatic on a given platform and consistent in terminology between platforms so that the core concepts are familiar whether adopting Bugsnag for one platform or many.
40-
3. We have strict style and linting guidelines as Bugsnag libraries are expected to work in crashy, multi-threaded environments and this often requires an intensive engineering design and code review process.
40+
Here’s a bit about our process designing and building the Bugsnag libraries:
4141

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.
4245

4346

4447
## Building

0 commit comments

Comments
 (0)