You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.md
+31-1
Original file line number
Diff line number
Diff line change
@@ -65,12 +65,42 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
65
65
faith may face temporary or permanent repercussions as determined by other
66
66
members of the project's leadership.
67
67
68
+
### Enforcement Guidelines
69
+
70
+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
71
+
72
+
#### 1. Correction
73
+
74
+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
75
+
76
+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
77
+
78
+
#### 2. Warning
79
+
80
+
**Community Impact**: A violation through a single incident or series of actions.
81
+
82
+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
83
+
84
+
#### 3. Temporary Ban
85
+
86
+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
87
+
88
+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
89
+
90
+
#### 4. Permanent Ban
91
+
92
+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
93
+
94
+
**Consequence**: A permanent ban from any sort of public interaction within the community.
95
+
68
96
## Attribution
69
97
70
98
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
99
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
100
73
101
[homepage]: https://www.contributor-covenant.org
74
102
103
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
104
+
75
105
For answers to common questions about this code of conduct, see
76
-
https://www.contributor-covenant.org/faq
106
+
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-113
Original file line number
Diff line number
Diff line change
@@ -4,51 +4,39 @@ We want this community to be friendly and respectful to each other. Please follo
4
4
5
5
## Development workflow
6
6
7
-
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
7
+
To get started with the project, run `bun install` in the root directory to install the required dependencies for each package:
8
8
9
9
```sh
10
-
yarn
10
+
bun i
11
11
```
12
12
13
-
> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
13
+
> While it's possible to use [`npm`](https://github.com/npm/cli), [`yarn`](https://classic.yarnpkg.com/), or [`pnpm`](https://pnpm.io), the tooling is built around [`bun`](https://bun.sh), so you'll have an easier time if you use `bun` for development.
14
14
15
15
While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
16
16
17
17
To start the packager:
18
18
19
19
```sh
20
-
yarn example start
21
-
```
22
-
23
-
To run the example app on Android:
24
-
25
-
```sh
26
-
yarn example android
27
-
```
28
-
29
-
To run the example app on iOS:
30
-
31
-
```sh
32
-
yarn example ios
20
+
bun example
33
21
```
34
22
35
23
Make sure your code passes TypeScript and ESLint. Run the following to verify:
36
24
37
25
```sh
38
-
yarn typescript
39
-
yarn lint
26
+
bun tsx
27
+
bun lint
40
28
```
41
29
42
30
To fix formatting errors, run the following:
43
31
44
32
```sh
45
-
yarn lint --fix
33
+
bun lint-fix
46
34
```
47
35
48
36
Remember to add tests for your change if possible. Run the unit tests by:
49
37
50
38
```sh
51
-
yarntest
39
+
buntest
52
40
```
53
41
54
42
To edit the Objective-C files, open `example/ios/QuickCryptoExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-quick-crypto`.
@@ -81,20 +69,18 @@ We use [release-it](https://github.com/release-it/release-it) to make it easier
81
69
To publish new versions, run the following:
82
70
83
71
```sh
84
-
yarn release
72
+
bun release
85
73
```
86
74
87
75
### Scripts
88
76
89
77
The `package.json` file contains various scripts for common tasks:
90
78
91
-
-`yarn bootstrap`: setup project by installing all dependencies and pods.
92
-
-`yarn typescript`: type-check files with TypeScript.
93
-
-`yarn lint`: lint files with ESLint.
94
-
-`yarn test`: run unit tests with Jest.
95
-
-`yarn example start`: start the Metro server for the example app.
96
-
-`yarn example android`: run the example app on Android.
97
-
-`yarn example ios`: run the example app on iOS.
79
+
-`bun bootstrap`: setup project by installing all dependencies and pods.
80
+
-`bun tsc`: type-check files with TypeScript.
81
+
-`bun lint`: lint files with ESLint.
82
+
-`bun test`: run unit tests with Jest.
83
+
-`bun example`: start the Metro server for the example app.
98
84
99
85
### Sending a pull request
100
86
@@ -107,88 +93,3 @@ When you're sending a pull request:
107
93
- Review the documentation to make sure it looks good.
108
94
- Follow the pull request template when opening a pull request.
109
95
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
110
-
111
-
## Code of Conduct
112
-
113
-
### Our Pledge
114
-
115
-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
116
-
117
-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
118
-
119
-
### Our Standards
120
-
121
-
Examples of behavior that contributes to a positive environment for our community include:
122
-
123
-
- Demonstrating empathy and kindness toward other people
124
-
- Being respectful of differing opinions, viewpoints, and experiences
125
-
- Giving and gracefully accepting constructive feedback
126
-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
127
-
- Focusing on what is best not just for us as individuals, but for the overall community
128
-
129
-
Examples of unacceptable behavior include:
130
-
131
-
- The use of sexualized language or imagery, and sexual attention or
132
-
advances of any kind
133
-
- Trolling, insulting or derogatory comments, and personal or political attacks
134
-
- Public or private harassment
135
-
- Publishing others' private information, such as a physical or email
136
-
address, without their explicit permission
137
-
- Other conduct which could reasonably be considered inappropriate in a
138
-
professional setting
139
-
140
-
### Enforcement Responsibilities
141
-
142
-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
143
-
144
-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
145
-
146
-
### Scope
147
-
148
-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
149
-
150
-
### Enforcement
151
-
152
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
153
-
154
-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
155
-
156
-
### Enforcement Guidelines
157
-
158
-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
159
-
160
-
#### 1. Correction
161
-
162
-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
163
-
164
-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
165
-
166
-
#### 2. Warning
167
-
168
-
**Community Impact**: A violation through a single incident or series of actions.
169
-
170
-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
171
-
172
-
#### 3. Temporary Ban
173
-
174
-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
175
-
176
-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
177
-
178
-
#### 4. Permanent Ban
179
-
180
-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
181
-
182
-
**Consequence**: A permanent ban from any sort of public interaction within the community.
183
-
184
-
### Attribution
185
-
186
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
187
-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
188
-
189
-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
190
-
191
-
[homepage]: https://www.contributor-covenant.org
192
-
193
-
For answers to common questions about this code of conduct, see the FAQ at
194
-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
0 commit comments