Skip to content

Commit d1b3ff8

Browse files
Merge pull request #7 from Vonage/VIDECO-11392
chore: [VIDECO-11392] Update COC, License and Contributing files
2 parents bc2d3c4 + f57ce97 commit d1b3ff8

File tree

4 files changed

+266
-142
lines changed

4 files changed

+266
-142
lines changed

CODE_OF_CONDUCT.md

Lines changed: 32 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,85 @@
1+
12
# Contributor Covenant Code of Conduct
23

34
## Our Pledge
45

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
6+
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.
117

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
149

1510
## Our Standards
1611

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
12+
Examples of behavior that contributes to a positive environment for our community include:
1913

20-
- Demonstrating empathy and kindness toward other people
21-
- Being respectful of differing opinions, viewpoints, and experiences
22-
- Giving and gracefully accepting constructive feedback
23-
- Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
- Focusing on what is best not just for us as individuals, but for the
26-
overall community
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
2719

2820
Examples of unacceptable behavior include:
2921

30-
- The use of sexualized language or imagery, and sexual attention or
22+
* The use of sexualized language or imagery, and sexual attention or
3123
advances of any kind
32-
- Trolling, insulting or derogatory comments, and personal or political attacks
33-
- Public or private harassment
34-
- Publishing others' private information, such as a physical or email
24+
* Trolling, insulting or derogatory comments, and personal or political attacks
25+
* Public or private harassment
26+
* Publishing others' private information, such as a physical or email
3527
address, without their explicit permission
36-
- Other conduct which could reasonably be considered inappropriate in a
28+
* Other conduct which could reasonably be considered inappropriate in a
3729
professional setting
3830

3931
## Enforcement Responsibilities
4032

41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
33+
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.
4534

46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
35+
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.
5036

5137
## Scope
5238

53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
39+
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.
5840

5941
## Enforcement
6042

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
devrel@vonage.com.
64-
All complaints will be reviewed and investigated promptly and fairly.
43+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [devrel@vonage.com](mailto:devrel@vonage.com). All complaints will be reviewed and investigated promptly and fairly.
6544

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
45+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
6846

6947
## Enforcement Guidelines
7048

71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
49+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
7350

7451
### 1. Correction
7552

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
53+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
7854

79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
55+
**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.
8256

8357
### 2. Warning
8458

85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
59+
**Community Impact**: A violation through a single incident or series of actions.
8760

88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
61+
**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.
9462

9563
### 3. Temporary Ban
9664

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
65+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
9966

100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
67+
**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.
10568

10669
### 4. Permanent Ban
10770

108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
71+
**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.
11172

112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
73+
**Consequence**: A permanent ban from any sort of public interaction within the community.
11474

11575
## Attribution
11676

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
77+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
78+
available at `https://www.contributor-covenant.org/version/2/0/code_of_conduct.html`.
12079

121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
80+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
12381

12482
[homepage]: https://www.contributor-covenant.org
12583

12684
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
85+
`https://www.contributor-covenant.org/faq`. Translations are available at `https://www.contributor-covenant.org/translations`.

CONTRIBUTING.md

Lines changed: 32 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,32 @@
1-
# Contributing Guidelines
2-
3-
If you're interested in contributing to this project, here are a few ways to do so:
4-
5-
- Bug fixes
6-
- If you find a bug, please first report it using Github Issues.
7-
- Issues that have already been identified as a bug will be labelled `bug`.
8-
- If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
9-
- Include a test that isolates the bug and verifies that it was fixed.
10-
- New Features
11-
- If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new Github Issue.
12-
- Issues that have been identified as a feature request will be labelled `enhancement`.
13-
- If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at the time.
14-
- Documentation & Miscellaneous
15-
- If you think the documentation could be clearer, or you have an alternative
16-
implementation of something that may have more advantages, we would love to hear it.
17-
- If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
18-
- If not, open a Github Issue to discuss the idea first.
19-
20-
## Requirements
21-
22-
For a contribution to be accepted:
23-
24-
- Code must follow existing styling conventions
25-
- Commit messages must be descriptive. Related issues should be mentioned by number.
26-
- The [sample applications](https://github.com/Vonage/vonage-video-react-native-sdk-samples) must build with your changes.
27-
28-
If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still continue to add more commits to the branch you have sent the Pull Request from.
29-
30-
## How To
31-
32-
1. Fork this repository on GitHub.
33-
2. Clone/fetch your fork to your local development machine.
34-
3. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
35-
4. Make your changes and commit them.
36-
5. Test your changes with the [sample applications](https://github.com/Vonage/vonage-video-react-native-sdk-samples). (you can use `npm pack` and `npm install` to install a local version of the library.)
37-
6. Push your new branch to your fork. (e.g. `git push myname issue-12`)
38-
7. Open a Pull Request from your new branch to the original fork's `master` branch.
39-
40-
## Development Guidelines
41-
42-
1. Follow [installation guidelines](README.md).
43-
2. Modify JS components in `src/js/`.
44-
3. Modify iOS components in `ios/`.
45-
4. Modify Android components in `android/`.
1+
# Getting Involved
2+
3+
## Welcome to Contributors
4+
Thank you for your interest in contributing to our open source **OpenTok Network Test** application! We're excited to have you join our community and help improve this project.
5+
6+
## Getting Started
7+
Before you begin, please review the following:
8+
- Read our Code of Conduct to understand our community standards.
9+
- Check the README.md for an overview of the project and setup instructions.
10+
- Browse the open issues to see what needs attention.
11+
12+
## Contributing
13+
14+
### Opening an Issue - Bug Reports or Feature Requests
15+
16+
We always welcome feedback, if you've seen something that isn't quite right or you have a suggestion for a new feature, please go ahead and open an issue in this project. Select the appropriate template and include as much information as you have, it really helps.
17+
18+
### Making a Code Change
19+
20+
We're always open to pull requests, but these should be small and clearly described so that we can understand what you're trying to do. Feel free to open an issue first and get some discussion going.
21+
22+
When you're ready to start coding, fork this repository to your own GitHub account and make your changes in a new branch based on develop. Once you're happy, open a pull request to merge into develop and explain what the change is and why you think we should include it in our project.
23+
24+
All the commits pushed into *develop* and *master* branches have to be signed. Please refer to [this guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Commits that are not signed can't be merged into *develop* or *master* branches.
25+
26+
### Branching
27+
28+
Our *master* branch is the evergreen source of truth for the Vonage Video API Reference App for React. However, all new development should be done in the develop branch. Contributions should be made by branching off develop, and pull requests should be submitted against develop. Periodically, develop will be merged into master as a batch.
29+
30+
Internally, we use Jira for issue tracking. Issue and feature branches use the format DEVELOPERNAME/TICKETNUMBER-SHORTDESCRIPTION e.g. alicesmith/VIDCS-123-fix-broken-icon. If you'd like to contribute a pull request, please use a branch on your fork with a descriptive name e.g. **fix-broken-icon**.
31+
32+
Release versions use the format v-RELEASENUMBER number, e.g. v1.0.0. We use [semantic versioning](https://semver.org/) for our releases.

0 commit comments

Comments
 (0)