Skip to content

Commit d9981a8

Browse files
authored
Project guidelines update (#57)
* Updated CONTRIBUTION.md file * Added CODE_OF_CONDUCT.md file
1 parent cd8d8c0 commit d9981a8

2 files changed

Lines changed: 97 additions & 95 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
### Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or
22+
advances of any kind
23+
- Trolling, insulting or derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or email
26+
address, without their explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a
28+
professional setting
29+
30+
### Enforcement Responsibilities
31+
32+
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.
33+
34+
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.
35+
36+
### Scope
37+
38+
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.
39+
40+
### Enforcement
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
### Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
#### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**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.
53+
54+
#### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**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.
59+
60+
#### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**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.
65+
66+
#### 4. Permanent Ban
67+
68+
**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.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
### Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
75+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
76+
77+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
81+
For answers to common questions about this code of conduct, see the FAQ at
82+
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 15 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,29 @@ We want this community to be friendly and respectful to each other. Please follo
66

77
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
88

9-
```sh
10-
yarn
11-
```
12-
9+
```sh
10+
yarn
11+
```
1312

1413
While developing, you can run the 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.
1514

1615
To start the packager:
1716

18-
```sh
17+
```sh
1918
yarn start
20-
```
19+
```
2120

2221
Remember to add tests for your change if possible. Run the unit tests by:
2322

24-
```sh
25-
yarn test
26-
```
23+
```sh
24+
yarn test
25+
```
26+
27+
If you made a change that will update the documentation, please run:
28+
29+
```sh
30+
yarn build:docs
31+
```
2732

2833
### Commit message convention
2934

@@ -36,16 +41,12 @@ We follow the [conventional commits specification](https://www.conventionalcommi
3641
- `test`: adding or updating tests, e.g. add integration tests using detox.
3742
- `chore`: tooling changes, e.g. change CI config.
3843

39-
Our pre-commit hooks verify that your commit message matches this format when committing.
40-
4144
### Linting and tests
4245

4346
[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
4447

4548
We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
4649

47-
Our pre-commit hooks verify that the linter and tests pass when committing.
48-
4950
### Sending a pull request
5051

5152
> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
@@ -58,85 +59,4 @@ When you're sending a pull request:
5859
- Follow the pull request template when opening a pull request.
5960
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
6061

61-
## Code of Conduct
62-
63-
### Our Pledge
64-
65-
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.
66-
67-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
68-
69-
### Our Standards
70-
71-
Examples of behavior that contributes to a positive environment for our community include:
72-
73-
- Demonstrating empathy and kindness toward other people
74-
- Being respectful of differing opinions, viewpoints, and experiences
75-
- Giving and gracefully accepting constructive feedback
76-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
77-
- Focusing on what is best not just for us as individuals, but for the overall community
78-
79-
Examples of unacceptable behavior include:
80-
81-
- The use of sexualized language or imagery, and sexual attention or
82-
advances of any kind
83-
- Trolling, insulting or derogatory comments, and personal or political attacks
84-
- Public or private harassment
85-
- Publishing others' private information, such as a physical or email
86-
address, without their explicit permission
87-
- Other conduct which could reasonably be considered inappropriate in a
88-
professional setting
89-
90-
### Enforcement Responsibilities
91-
92-
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.
93-
94-
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.
95-
96-
### Scope
97-
98-
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.
99-
100-
### Enforcement
101-
102-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
103-
104-
### Enforcement Guidelines
105-
106-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
107-
108-
#### 1. Correction
109-
110-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
111-
112-
**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.
113-
114-
#### 2. Warning
115-
116-
**Community Impact**: A violation through a single incident or series of actions.
117-
118-
**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.
119-
120-
#### 3. Temporary Ban
121-
122-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
123-
124-
**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.
125-
126-
#### 4. Permanent Ban
127-
128-
**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.
129-
130-
**Consequence**: A permanent ban from any sort of public interaction within the community.
131-
132-
### Attribution
133-
134-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
135-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
136-
137-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
138-
139-
[homepage]: https://www.contributor-covenant.org
140-
141-
For answers to common questions about this code of conduct, see the FAQ at
142-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
62+
After opening a pull request, our CI will verify that the formatting is correct, tests are passing and documentation is up to date.

0 commit comments

Comments
 (0)