Skip to content

Commit e8f2913

Browse files
weicongs-amazonjackiehanyang
authored andcommitted
udpate the docs for opensearch project (opensearch-project#8)
1 parent ff2279c commit e8f2913

File tree

3 files changed

+77
-4
lines changed

3 files changed

+77
-4
lines changed

CODE_OF_CONDUCT.md

+25-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
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-
opensource-codeofconduct@amazon.com with any additional questions or comments.
1+
2+
This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.
3+
4+
5+
**Our open source communities endeavor to:**
6+
7+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
8+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
9+
* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
10+
* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
11+
12+
13+
**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**
14+
15+
* The use of violent threats, abusive, discriminatory, or derogatory language;
16+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
17+
* Posting of sexually explicit or violent content;
18+
* The use of sexualized language and unwelcome sexual attention or advances;
19+
* Public or private harassment of any kind;
20+
* Publishing private information, such as physical or electronic address, without permission;
21+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
22+
* Advocating for or encouraging any of the above behaviors.
23+
* Enforcement and Reporting Code of Conduct Issues:
24+
25+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,50 @@ This project has adopted the [Amazon Open Source Code of Conduct](https://aws.gi
4949
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
5050
opensource-codeofconduct@amazon.com with any additional questions or comments.
5151

52+
## Developer Certificate of Origin
53+
54+
OpenSearch is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE.txt file](./LICENSE.txt)). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
55+
56+
We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
57+
58+
The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).
59+
60+
```
61+
Developer's Certificate of Origin 1.1
62+
63+
By making a contribution to this project, I certify that:
64+
65+
(a) The contribution was created in whole or in part by me and I
66+
have the right to submit it under the open source license
67+
indicated in the file; or
68+
69+
(b) The contribution is based upon previous work that, to the
70+
best of my knowledge, is covered under an appropriate open
71+
source license and I have the right under that license to
72+
submit that work with modifications, whether created in whole
73+
or in part by me, under the same open source license (unless
74+
I am permitted to submit under a different license), as
75+
Indicated in the file; or
76+
77+
(c) The contribution was provided directly to me by some other
78+
person who certified (a), (b) or (c) and I have not modified
79+
it.
80+
81+
(d) I understand and agree that this project and the contribution
82+
are public and that a record of the contribution (including
83+
all personal information I submit with it, including my
84+
sign-off) is maintained indefinitely and may be redistributed
85+
consistent with this project or the open source license(s)
86+
involved.
87+
```
88+
We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
89+
90+
Each commit must include a DCO which looks like this
91+
92+
```
93+
Signed-off-by: Jane Smith <jane.smith@email.com>
94+
```
95+
You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message.
5296

5397
## Security issue notifications
5498
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.

MAINTAINERS.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# OpenSearch Machine Learning Maintainers
2+
3+
## Maintainers
4+
| Maintainer | GitHub ID | Affiliation |
5+
| --------------- | --------- | ----------- |
6+
| Hanguang Zhang | [zhanghg08](https://github.com/zhanghg08) | Amazon |
7+
| Jing Zhang | [jngz-es](https://github.com/jngz-es) | Amazon |
8+
| Weicong Sun | [weicongs-amazon](https://github.com/weicongs-amazon) | Amazon |

0 commit comments

Comments
 (0)