Skip to content

Commit cb47124

Browse files
committed
fri: Update CODE_OF_CONDUCT.md and CONTRIBUTING.md
Signed-off-by: Devaraj Ranganna <[email protected]>
1 parent 91bdb3a commit cb47124

File tree

2 files changed

+44
-159
lines changed

2 files changed

+44
-159
lines changed

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,4 @@
1-
2-
# Contributor Covenant Code of Conduct
3-
4-
## Our Pledge
5-
6-
We as members, contributors, and leaders pledge to make participation in our
7-
community a harassment-free experience for everyone, regardless of age, body
8-
size, visible or invisible disability, ethnicity, sex characteristics, gender
9-
identity and expression, level of experience, education, socio-economic status,
10-
nationality, personal appearance, race, caste, color, religion, or sexual identity
11-
and orientation.
12-
13-
We pledge to act and interact in ways that contribute to an open, welcoming,
14-
diverse, inclusive, and healthy community.
15-
16-
## Our Standards
17-
18-
Examples of behavior that contributes to a positive environment for our
19-
community include:
20-
21-
* Demonstrating empathy and kindness toward other people
22-
* Being respectful of differing opinions, viewpoints, and experiences
23-
* Giving and gracefully accepting constructive feedback
24-
* Accepting responsibility and apologizing to those affected by our mistakes,
25-
and learning from the experience
26-
* Focusing on what is best not just for us as individuals, but for the
27-
overall community
28-
29-
Examples of unacceptable behavior include:
30-
31-
* The use of sexualized language or imagery, and sexual attention or
32-
advances of any kind
33-
* Trolling, insulting or derogatory comments, and personal or political attacks
34-
* Public or private harassment
35-
* Publishing others' private information, such as a physical or email
36-
address, without their explicit permission
37-
* Other conduct which could reasonably be considered inappropriate in a
38-
professional setting
39-
40-
## Enforcement Responsibilities
41-
42-
Community leaders are responsible for clarifying and enforcing our standards of
43-
acceptable behavior and will take appropriate and fair corrective action in
44-
response to any behavior that they deem inappropriate, threatening, offensive,
45-
or harmful.
46-
47-
Community leaders have the right and responsibility to remove, edit, or reject
48-
comments, commits, code, wiki edits, issues, and other contributions that are
49-
not aligned to this Code of Conduct, and will communicate reasons for moderation
50-
decisions when appropriate.
51-
52-
## Scope
53-
54-
This Code of Conduct applies within all community spaces, and also applies when
55-
an individual is officially representing the community in public spaces.
56-
Examples of representing our community include using an official e-mail address,
57-
posting via an official social media account, or acting as an appointed
58-
representative at an online or offline event.
59-
60-
## Enforcement
61-
62-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the community leaders responsible for enforcement. This role is
64-
currently filled by the project maintainers whose contact details can be
65-
found in [Maintainers](Maintainers.md).
66-
All complaints will be reviewed and investigated promptly and fairly.
67-
68-
All community leaders are obligated to respect the privacy and security of the
69-
reporter of any incident.
70-
71-
## Enforcement Guidelines
72-
73-
Community leaders will follow these Community Impact Guidelines in determining
74-
the consequences for any action they deem in violation of this Code of Conduct:
75-
76-
### 1. Correction
77-
78-
**Community Impact**: Use of inappropriate language or other behavior deemed
79-
unprofessional or unwelcome in the community.
80-
81-
**Consequence**: A private, written warning from community leaders, providing
82-
clarity around the nature of the violation and an explanation of why the
83-
behavior was inappropriate. A public apology may be requested.
84-
85-
### 2. Warning
86-
87-
**Community Impact**: A violation through a single incident or series
88-
of actions.
89-
90-
**Consequence**: A warning with consequences for continued behavior. No
91-
interaction with the people involved, including unsolicited interaction with
92-
those enforcing the Code of Conduct, for a specified period of time. This
93-
includes avoiding interactions in community spaces as well as external channels
94-
like social media. Violating these terms may lead to a temporary or
95-
permanent ban.
96-
97-
### 3. Temporary Ban
98-
99-
**Community Impact**: A serious violation of community standards, including
100-
sustained inappropriate behavior.
101-
102-
**Consequence**: A temporary ban from any sort of interaction or public
103-
communication with the community for a specified period of time. No public or
104-
private interaction with the people involved, including unsolicited interaction
105-
with those enforcing the Code of Conduct, is allowed during this period.
106-
Violating these terms may lead to a permanent ban.
107-
108-
### 4. Permanent Ban
109-
110-
**Community Impact**: Demonstrating a pattern of violation of community
111-
standards, including sustained inappropriate behavior, harassment of an
112-
individual, or aggression toward or disparagement of classes of individuals.
113-
114-
**Consequence**: A permanent ban from any sort of public interaction within
115-
the community.
116-
117-
## Attribution
118-
119-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
120-
version 2.0, available at
121-
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
122-
123-
Community Impact Guidelines were inspired by
124-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
125-
126-
For answers to common questions about this code of conduct, see the FAQ at
127-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
128-
at [https://www.contributor-covenant.org/translations][translations].
129-
130-
[homepage]: https://www.contributor-covenant.org
131-
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
132-
[Mozilla CoC]: https://github.com/mozilla/diversity
133-
[FAQ]: https://www.contributor-covenant.org/faq
134-
[translations]: https://www.contributor-covenant.org/translations
1+
## Code of Conduct
2+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4+
[email protected] with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,59 @@
11
# Contributing Guidelines
22

3-
Thank you for your interest in contributing to the project. Whether it's a bug report, new feature, correction, or additional
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
44
documentation, we greatly value feedback and contributions from our community.
55

6-
# Developer’s Certificate of Origin
6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7+
information to effectively respond to your bug report or contribution.
78

8-
Each commit must have at least one `Signed-off-by:` line from the committer to
9-
certify that the contribution is made under the terms of the [Developer
10-
Certificate of Origin](./DCO.txt).
119

12-
If you set your `user.name` and `user.email` as part of your git configuration,
13-
you can add a signoff to your commit automatically with `git commit -s`. You
14-
have to use your real name (i.e., pseudonyms or anonymous contributions cannot
15-
be made). This is because the DCO is a legally binding document.
10+
## Reporting Bugs/Feature Requests
1611

17-
# Maintainers and code owners
12+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1813

19-
All contributions are ultimately merged by the maintainers listed below.
20-
Technical ownership of most parts of the codebase falls on the code owners
21-
listed in [CODEOWNERS](CODEOWNERS) file. An acknowledgement from these code
22-
owners is required before the maintainers merge a contribution.
14+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
2316

24-
# Code Formatting
25-
IoT Reference Integration for Corstone-300 files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [uncrustify.cfg](uncrustify.cfg) file.
17+
* A reproducible test case or series of steps
18+
* The version of our code being used
19+
* Any modifications you've made relevant to the bug
20+
* Anything unusual about your environment or deployment
2621

27-
Maintainers
28-
===========
2922

30-
Devaraj Ranganna
31-
:email: `Devaraj Ranganna <[email protected]>`
32-
:gitlab: `https://gitlab.arm.com/urutva`
23+
## Contributing via Pull Requests
24+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
3325

26+
1. You are working against the latest source on the *main* branch.
27+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3429

35-
## Security issues reporting
30+
To send us a pull request, please:
3631

37-
If you find any security vulnerabilities, please do not report it in the GitLab issue tracker. Instead, send an email to the security team at [email protected] stating that you may have found a security vulnerability in the Open IoT SDK.
32+
1. Fork the repository.
33+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34+
3. Ensure local tests pass.
35+
4. Commit to your fork using clear commit messages.
36+
5. Send us a pull request, answering any default questions in the pull request interface.
37+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3838

39-
More details can be found at [Arm Developer website](https://developer.arm.com/support/arm-security-updates/report-security-vulnerabilities).
39+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41+
42+
43+
## Finding contributions to work on
44+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
45+
46+
47+
## Code of Conduct
48+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50+
[email protected] with any additional questions or comments.
51+
52+
53+
## Security issue notifications
54+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
4055

4156

4257
## Licensing
4358

44-
See the [LICENSE](LICENSE) file for the project's licensing. Refer to [README.md](README.md#License) for license of other libraries. We will ask you to confirm the licensing of your contribution.
59+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

0 commit comments

Comments
 (0)