Skip to content

Commit e84adf6

Browse files
authored
chore: Link from README to Contributing guide (#887)
1 parent 6ff6eff commit e84adf6

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

.changeset/fifty-cats-leave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'react-native-app-auth': patch
3+
---
4+
5+
Update README to link to Contributing guide

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -473,19 +473,23 @@ Values are in the `code` field of the rejected Error object.
473473
- `registration_failed` - could not register
474474
- `browser_not_found` (Android only) - no suitable browser installed
475475
476-
#### Note about client secrets
476+
## Note about client secrets
477477
478478
Some authentication providers, including examples cited below, require you to provide a client secret. The authors of the AppAuth library
479479
480480
> [strongly recommend](https://github.com/openid/AppAuth-Android#utilizing-client-secrets-dangerous) you avoid using static client secrets in your native applications whenever possible. Client secrets derived via a dynamic client registration are safe to use, but static client secrets can be easily extracted from your apps and allow others to impersonate your app and steal user data. If client secrets must be used by the OAuth2 provider you are integrating with, we strongly recommend performing the code exchange step on your backend, where the client secret can be kept hidden.
481481
482482
Having said this, in some cases using client secrets is unavoidable. In these cases, a `clientSecret` parameter can be provided to `authorize`/`refresh` calls when performing a token request.
483483
484-
#### Token Storage
484+
## Token Storage
485485
486486
Recommendations on secure token storage can be found [here](./docs/token-storage.md).
487487
488-
#### Maintenance Status
488+
## Contributing
489+
490+
Please see our [contributing guide](./.github/CONTRIBUTING.md).
491+
492+
## Maintenance Status
489493
490494
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
491495

0 commit comments

Comments
 (0)