-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add and update opensearch-devops related documents (#34)
Signed-off-by: Peter Zhu <[email protected]>
- Loading branch information
1 parent
5e0f435
commit 43cc30b
Showing
9 changed files
with
79 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ## Admins | ||
|
|
||
| | Admin | GitHub ID | Affiliation | | ||
| | --------------- | --------------------------------------- | ----------- | | ||
| | Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon | | ||
|
|
||
| [This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins do in this repo. and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,22 @@ | ||
| ## Code of Conduct | ||
| This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
| [email protected] with any additional questions or comments. | ||
| 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. | ||
|
|
||
| **Our open source communities endeavor to:** | ||
|
|
||
| * Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language. | ||
| * Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute. | ||
| * 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. | ||
| * 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. | ||
|
|
||
| **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:** | ||
|
|
||
| * The use of violent threats, abusive, discriminatory, or derogatory language; | ||
| * Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation; | ||
| * Posting of sexually explicit or violent content; | ||
| * The use of sexualized language and unwelcome sexual attention or advances; | ||
| * Public or private harassment of any kind; | ||
| * Publishing private information, such as physical or electronic address, without permission; | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting; | ||
| * Advocating for or encouraging any of the above behaviors. | ||
| * Enforcement and Reporting Code of Conduct Issues: | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,4 @@ | ||
| # Contributing Guidelines | ||
| ## Contributing to this Project | ||
|
|
||
| Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional | ||
| documentation, we greatly value feedback and contributions from our community. | ||
|
|
||
| Please read through this document before submitting any issues or pull requests to ensure we have all the necessary | ||
| information to effectively respond to your bug report or contribution. | ||
|
|
||
| ## Reporting Bugs/Feature Requests | ||
|
|
||
| We welcome you to use the GitHub issue tracker to report bugs or suggest features. | ||
|
|
||
| When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already | ||
| reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: | ||
|
|
||
| - A reproducible test case or series of steps | ||
| - The version of our code being used | ||
| - Any modifications you've made relevant to the bug | ||
| - Anything unusual about your environment or deployment | ||
|
|
||
| ## Sign your work | ||
| The sign-off is a simple line at the end of each commit, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. if you can certify the below | ||
| ``` | ||
| By making a contribution to this project, I certify that: | ||
| (a) The contribution was created in whole or in part by me and I | ||
| have the right to submit it under the open source license | ||
| indicated in the file; or | ||
| (b) The contribution is based upon previous work that, to the best | ||
| of my knowledge, is covered under an appropriate open source | ||
| license and I have the right under that license to submit that | ||
| work with modifications, whether created in whole or in part | ||
| by me, under the same open source license (unless I am | ||
| permitted to submit under a different license), as indicated | ||
| in the file; or | ||
| (c) The contribution was provided directly to me by some other | ||
| person who certified (a), (b) or (c) and I have not modified | ||
| it. | ||
| (d) I understand and agree that this project and the contribution | ||
| are public and that a record of the contribution (including all | ||
| personal information I submit with it, including my sign-off) is | ||
| maintained indefinitely and may be redistributed consistent with | ||
| this project or the open source license(s) involved. | ||
| ``` | ||
| then you just add a line to every git commit message: | ||
| ``` | ||
| Signed-off-by: Bob Sanders <[email protected]> | ||
| ``` | ||
| You can sign off your work easily by adding the configuration in github | ||
| ``` | ||
| git config user.name "Bob Sanders" | ||
| git config user.email "[email protected]" | ||
| ``` | ||
| Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g. | ||
| ``` | ||
| git commit -s -m "my first commit" | ||
| ``` | ||
|
|
||
| ## Contributing via Pull Requests | ||
|
|
||
| Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: | ||
|
|
||
| 1. You are working against the latest source on the *main* branch. | ||
| 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. | ||
| 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. | ||
|
|
||
| To send us a pull request, please: | ||
|
|
||
| 1. Fork the repository. | ||
| 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. | ||
| 3. Ensure local tests pass. | ||
| 4. Commit to your fork using clear commit messages. | ||
| 5. Send us a pull request, answering any default questions in the pull request interface. | ||
| 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. | ||
|
|
||
| GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and | ||
| [creating a pull request](https://help.github.com/articles/creating-a-pull-request/). | ||
|
|
||
| ## Finding contributions to work on | ||
|
|
||
| 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. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
| [email protected] with any additional questions or comments. | ||
|
|
||
| ## Security issue notifications | ||
|
|
||
| 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. | ||
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
| OpenSearch is a community project that is built and maintained by people just like **you**. | ||
| [This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| - [Developer Guide](#developer-guide) | ||
| - [Forking and Cloning](#forking-and-cloning) | ||
| - [Submitting Changes](#submitting-changes) | ||
|
|
||
| ## Developer Guide | ||
|
|
||
| So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do. | ||
|
|
||
| ### Forking and Cloning | ||
|
|
||
| Fork this repository on GitHub, and clone locally with `git clone`. | ||
|
|
||
| ### Submitting Changes | ||
|
|
||
| See [CONTRIBUTING](CONTRIBUTING.md). |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## Maintainers | ||
|
|
||
| | Maintainer | GitHub ID | Affiliation | | ||
| | --------------- | --------- | ----------- | | ||
| | Barani Bikshandi | [bbarani](https://github.com/bbarani) | Amazon | | ||
| | Peter Zhu | [peterzhuamazon](https://github.com/peterzhuamazon) | Amazon | | ||
| | Peter Nied | [peternied](https://github.com/peternied) | Amazon | | ||
| | Sayali Gaikawad | [gaiksaya](https://github.com/gaiksaya) | Amazon | | ||
|
|
||
| [This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| OpenSearch (https://opensearch.org/) | ||
| Copyright OpenSearch Contributors |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,39 @@ | ||
| - [Contributing](#contributing) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Security](#security) | ||
| - [Licensing](#licensing) | ||
| - [Questions](#Questions) | ||
| - [Issues](#Issues) | ||
| - [Copyright](#copyright) | ||
| <img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/> | ||
|
|
||
| # OpenSearch DevOps repository | ||
| - [OpenSearch Build](#opensearch-build) | ||
| - [Contributing](#contributing) | ||
| - [Getting Help](#getting-help) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Security](#security) | ||
| - [License](#license) | ||
| - [Copyright](#copyright) | ||
|
|
||
| ## OpenSearch DevOps | ||
|
|
||
| A community repository for devops-related code, such as Helm charts, Ansible playbooks, or Kubernetes etc... | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome you to get involved in development, documentation, and testing of the devops-related code in this repository | ||
| See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). | ||
|
|
||
| ## Getting Help | ||
|
|
||
| See our [contribution guidelines](CONTRIBUTING.md) to get started. | ||
| If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. | ||
|
|
||
| For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/). | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted an [Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
| This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## Security | ||
|
|
||
| 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. | ||
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
|
|
||
| ## Questions | ||
|
|
||
| If you have any questions, please join our community forum [here](https://discuss.opendistrocommunity.dev/) | ||
|
|
||
| ## Issues | ||
| ## License | ||
|
|
||
| File any issues [here](https://github.com/opensearch-project/opensearch-devops/issues). | ||
| This project is licensed under the [Apache v2.0 License](LICENSE.txt). | ||
|
|
||
| ## Copyright | ||
|
|
||
| Copyright 2021 OpenSearch Contributors | ||
| Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. |