From cb96d133fddb2adf5e4a4cf8ab1fda09c0eaf651 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 14:41:01 -0700 Subject: [PATCH 01/15] Update CoC --- CODE_OF_CONDUCT.md | 27 +++++++++++++++++++++++++-- sql-jdbc/CODE_OF_CONDUCT.md | 27 +++++++++++++++++++++++++-- sql-odbc/CODE_OF_CONDUCT.md | 28 ++++++++++++++++++++++++---- 3 files changed, 74 insertions(+), 8 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8543edd1cc..bd61be433d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,2 +1,25 @@ -## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). + +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: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. \ No newline at end of file diff --git a/sql-jdbc/CODE_OF_CONDUCT.md b/sql-jdbc/CODE_OF_CONDUCT.md index 8543edd1cc..bd61be433d 100644 --- a/sql-jdbc/CODE_OF_CONDUCT.md +++ b/sql-jdbc/CODE_OF_CONDUCT.md @@ -1,2 +1,25 @@ -## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). + +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: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. \ No newline at end of file diff --git a/sql-odbc/CODE_OF_CONDUCT.md b/sql-odbc/CODE_OF_CONDUCT.md index ec98f2b76e..bd61be433d 100644 --- a/sql-odbc/CODE_OF_CONDUCT.md +++ b/sql-odbc/CODE_OF_CONDUCT.md @@ -1,5 +1,25 @@ -## 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 -opensource-codeofconduct@amazon.com 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: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. \ No newline at end of file From a79d1b110fae3651a3d27cfbc2b17568b9d7b6e6 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 14:58:16 -0700 Subject: [PATCH 02/15] Update license --- LICENSE.txt | 1 - sql-jdbc/LICENSE | 3 +-- sql-odbc/LICENSE | 28 +++++++++++++++++++++++++++- 3 files changed, 28 insertions(+), 4 deletions(-) diff --git a/LICENSE.txt b/LICENSE.txt index 7a4a3ea242..f49a4e16e6 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,3 @@ - Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ diff --git a/sql-jdbc/LICENSE b/sql-jdbc/LICENSE index d645695673..f49a4e16e6 100644 --- a/sql-jdbc/LICENSE +++ b/sql-jdbc/LICENSE @@ -1,4 +1,3 @@ - Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -199,4 +198,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and - limitations under the License. + limitations under the License. \ No newline at end of file diff --git a/sql-odbc/LICENSE b/sql-odbc/LICENSE index 67db858821..f49a4e16e6 100644 --- a/sql-odbc/LICENSE +++ b/sql-odbc/LICENSE @@ -1,4 +1,3 @@ - Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -173,3 +172,30 @@ defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file From f96422c6012b73d5f38f126692632b570af5f78a Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 15:12:21 -0700 Subject: [PATCH 03/15] Move developer guide --- CONTRIBUTING.md | 2 +- docs/developing.rst => DEVELOPER_GUIDE.rst | 7 +++---- README.md | 2 +- docs/dev/NewSQLEngine.md | 2 +- 4 files changed, 6 insertions(+), 7 deletions(-) rename docs/developing.rst => DEVELOPER_GUIDE.rst (99%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2760191a6a..38ce000589 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,7 @@ GitHub provides additional document on [forking a repository](https://help.githu ## Developing -For instructions for development in details, please refer to [Development Guide](./docs/developing.rst). +For instructions for development in details, please refer to [Developer Guide](./DEVELOPER_GUIDE.rst). ## 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'](../../labels/help%20wanted) issues is a great place to start. diff --git a/docs/developing.rst b/DEVELOPER_GUIDE.rst similarity index 99% rename from docs/developing.rst rename to DEVELOPER_GUIDE.rst index 5c854083c1..c0d53a0344 100644 --- a/docs/developing.rst +++ b/DEVELOPER_GUIDE.rst @@ -1,8 +1,8 @@ .. highlight:: sh -================= -Development Guide -================= +=============== +Developer Guide +=============== .. rubric:: Table of contents @@ -132,7 +132,6 @@ The plugin codebase is in standard layout of Gradle project:: │   ├── attributions.md │   ├── category.json │   ├── dev - │   ├── developing.rst │   ├── experiment │   └── user ├── gradle.properties diff --git a/README.md b/README.md index 13d955f2cf..0d8f4cb794 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The following projects have been merged into this repository as separate folders ## Documentation -Please refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/experiment/ppl/index.rst) and [Technical Documentation](https://opendistro.github.io/for-elasticsearch-docs) for detailed information on installing and configuring opendistro-elasticsearch-sql plugin. Looking to contribute? Read the instructions on [Development Guide](./docs/developing.rst) and then submit a patch! +Please refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/experiment/ppl/index.rst) and [Technical Documentation](https://opendistro.github.io/for-elasticsearch-docs) for detailed information on installing and configuring opendistro-elasticsearch-sql plugin. Looking to contribute? Read the instructions on [Developer Guide](./DEVELOPER_GUIDE.rst) and then submit a patch! ## SQL Engine V2 diff --git a/docs/dev/NewSQLEngine.md b/docs/dev/NewSQLEngine.md index 6bd067985f..1d28d66b23 100644 --- a/docs/dev/NewSQLEngine.md +++ b/docs/dev/NewSQLEngine.md @@ -67,7 +67,7 @@ No panic! You can roll back to old query engine easily by a plugin setting chang --- ## 4.How it's Implemented -If you're interested in the new query engine, please find more details in [Develop Guide](../developing.rst), [Architecture](./Architecture.md) and other docs in the dev folder. +If you're interested in the new query engine, please find more details in [Developer Guide](../../DEVELOPER_GUIDE.rst), [Architecture](./Architecture.md) and other docs in the dev folder. --- From c718fb719de859e3d8c866281212e125e905f671 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 15:27:04 -0700 Subject: [PATCH 04/15] Update README --- README.md | 2 +- sql-jdbc/README.md | 2 +- sql-odbc/README.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0d8f4cb794..7d38e53640 100644 --- a/README.md +++ b/README.md @@ -204,7 +204,7 @@ This project is based on the Apache 2.0-licensed [elasticsearch-sql](https://git ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications diff --git a/sql-jdbc/README.md b/sql-jdbc/README.md index 78f42b9155..621421ee01 100644 --- a/sql-jdbc/README.md +++ b/sql-jdbc/README.md @@ -508,7 +508,7 @@ Please refer to the [documentation](https://opendistro.github.io/for-elasticsear ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). +This project has adopted an [Open Source Code of Conduct](../CODE_OF_CONDUCT.md). ## Security issue notifications diff --git a/sql-odbc/README.md b/sql-odbc/README.md index b5e1944935..b303fe20bf 100644 --- a/sql-odbc/README.md +++ b/sql-odbc/README.md @@ -78,7 +78,7 @@ From the projects root directory, then build the project using Visual Studio (Wi ### Testing -**NOTE**: Some tests in ITODBCConnection will fail if a test DSN (Data Source Name) is not configured on your system. Refer to "Running Tests" in the [build instructions](./BUILD_INSTRUCTIONS.md) for more information on configuring this. +**NOTE**: Some tests in ITODBCConnection will fail if a test DSN (Data Source Name) is not configured on your system. Refer to "Running Tests" in the [build instructions](./docs/dev/BUILD_INSTRUCTIONS.md) for more information on configuring this. ## Documentation @@ -86,7 +86,7 @@ Please refer to the [documentation](https://opendistro.github.io/for-elasticsear ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications From a62a82c20b9315ea22002d1323e4a241fe475d50 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 15:30:04 -0700 Subject: [PATCH 05/15] Update NOTICE --- NOTICE | 14 ++++++++++++-- sql-jdbc/NOTICE | 14 ++++++++++++-- sql-odbc/NOTICE | 14 ++++++++++++-- 3 files changed, 36 insertions(+), 6 deletions(-) diff --git a/NOTICE b/NOTICE index 02e12cb32a..36b1c77777 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,15 @@ -Open Distribution for Elasticsearch SQL -Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. +OpenSearch +Copyright 2021 OpenSearch Contributors + +This product includes software developed by +Elasticsearch (http://www.elastic.co). +Copyright 2009-2018 Elasticsearch + +This product includes software developed by The Apache Software +Foundation (http://www.apache.org/). + +This product includes software developed by +Joda.org (http://www.joda.org/). This project is based on the Apache 2.0-licensed elasticsearch-sql project (https://github.com/NLPchina/elasticsearch-sql): diff --git a/sql-jdbc/NOTICE b/sql-jdbc/NOTICE index 7052bdc170..07e5757092 100644 --- a/sql-jdbc/NOTICE +++ b/sql-jdbc/NOTICE @@ -1,2 +1,12 @@ -Open Distro for Elasticsearch JDBC -Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. +OpenSearch +Copyright 2021 OpenSearch Contributors + +This product includes software developed by +Elasticsearch (http://www.elastic.co). +Copyright 2009-2018 Elasticsearch + +This product includes software developed by The Apache Software +Foundation (http://www.apache.org/). + +This product includes software developed by +Joda.org (http://www.joda.org/). \ No newline at end of file diff --git a/sql-odbc/NOTICE b/sql-odbc/NOTICE index 3dec9cbc81..07e5757092 100644 --- a/sql-odbc/NOTICE +++ b/sql-odbc/NOTICE @@ -1,2 +1,12 @@ -Open Distro for Elasticsearch ODBC -Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. \ No newline at end of file +OpenSearch +Copyright 2021 OpenSearch Contributors + +This product includes software developed by +Elasticsearch (http://www.elastic.co). +Copyright 2009-2018 Elasticsearch + +This product includes software developed by The Apache Software +Foundation (http://www.apache.org/). + +This product includes software developed by +Joda.org (http://www.joda.org/). \ No newline at end of file From 6588a499dffec3804aaa41bc42b43a62be290c73 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 15:35:35 -0700 Subject: [PATCH 06/15] Add SPDX licence header --- build.gradle | 11 +++++++++++ gradle.properties | 12 ++++++++++++ settings.gradle | 11 +++++++++++ 3 files changed, 34 insertions(+) diff --git a/build.gradle b/build.gradle index 4960147400..d9ac10353f 100644 --- a/build.gradle +++ b/build.gradle @@ -1,3 +1,14 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + /* * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * diff --git a/gradle.properties b/gradle.properties index 7f8918e354..567b500ccc 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,3 +1,15 @@ + +# +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. +# + # # Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. # diff --git a/settings.gradle b/settings.gradle index 97aeab1de0..b8557f68d3 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,3 +1,14 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + /* * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * From 93c9c3fa70d6e784ac0b42b2f51cdff608db0fe1 Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 15:47:15 -0700 Subject: [PATCH 07/15] Add SPDX licence header --- build-tools/sqlplugin-coverage.gradle | 11 ++++++++++ common/build.gradle | 30 +++++++++++++++++++++++++++ core/build.gradle | 30 +++++++++++++++++++++++++++ elasticsearch/build.gradle | 30 +++++++++++++++++++++++++++ integ-test/build.gradle | 30 +++++++++++++++++++++++++++ legacy/build.gradle | 30 +++++++++++++++++++++++++++ plugin/build.gradle | 30 +++++++++++++++++++++++++++ ppl/build.gradle | 30 +++++++++++++++++++++++++++ protocol/build.gradle | 30 +++++++++++++++++++++++++++ sql/build.gradle | 30 +++++++++++++++++++++++++++ 10 files changed, 281 insertions(+) diff --git a/build-tools/sqlplugin-coverage.gradle b/build-tools/sqlplugin-coverage.gradle index 5d16e8376f..dd488cf6a5 100644 --- a/build-tools/sqlplugin-coverage.gradle +++ b/build-tools/sqlplugin-coverage.gradle @@ -1,3 +1,14 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + /* * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * diff --git a/common/build.gradle b/common/build.gradle index 08de79ca76..481f2e541a 100644 --- a/common/build.gradle +++ b/common/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" diff --git a/core/build.gradle b/core/build.gradle index 45f484c2dc..b40d585efe 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" diff --git a/elasticsearch/build.gradle b/elasticsearch/build.gradle index 9b99c1789f..4507fee14a 100644 --- a/elasticsearch/build.gradle +++ b/elasticsearch/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" diff --git a/integ-test/build.gradle b/integ-test/build.gradle index e47372df07..99b7e278ff 100644 --- a/integ-test/build.gradle +++ b/integ-test/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + import org.elasticsearch.gradle.test.RestIntegTestTask import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform diff --git a/legacy/build.gradle b/legacy/build.gradle index 4ffc84ce1c..07895fc8be 100644 --- a/legacy/build.gradle +++ b/legacy/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id 'io.freefair.lombok' diff --git a/plugin/build.gradle b/plugin/build.gradle index c28f9bd954..c2e200371c 100644 --- a/plugin/build.gradle +++ b/plugin/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id 'jacoco' diff --git a/ppl/build.gradle b/ppl/build.gradle index 69a27264a5..14fdb25978 100644 --- a/ppl/build.gradle +++ b/ppl/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" diff --git a/protocol/build.gradle b/protocol/build.gradle index 61bd5ded89..04dc627833 100644 --- a/protocol/build.gradle +++ b/protocol/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" diff --git a/sql/build.gradle b/sql/build.gradle index d57f050fef..633a9541ed 100644 --- a/sql/build.gradle +++ b/sql/build.gradle @@ -1,3 +1,33 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + plugins { id 'java' id "io.freefair.lombok" From d2bff9a9ec5e174e69f687219a53f681190752fb Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 16:09:39 -0700 Subject: [PATCH 08/15] Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 632000dae5..2e325678fe 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,16 @@ -*Issue #, if available:* +### Description +[Describe what this change achieves] + +### Issues Resolved +[List any issues this PR will resolve] + +### Check List +- [ ] New functionality includes testing. + - [ ] All tests pass, including unit test, integration test and doctest +- [ ] New functionality has been documented. + - [ ] New functionality has javadoc added + - [ ] New functionality has user manual doc added +- [ ] Commits are signed per the DCO using --signoff -*Description of changes:* - - -By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. \ No newline at end of file +By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. +For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file From c77d3b863e467fc39700c8826650a1ac304d89fb Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 16:28:09 -0700 Subject: [PATCH 09/15] Add SPDX licence header --- sql-jdbc/build.gradle | 11 +++++++++++ sql-jdbc/settings.gradle | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/sql-jdbc/build.gradle b/sql-jdbc/build.gradle index 6c92e87990..876c95b5f1 100644 --- a/sql-jdbc/build.gradle +++ b/sql-jdbc/build.gradle @@ -1,3 +1,14 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + /* * Copyright <2019> Amazon.com, Inc. or its affiliates. All Rights Reserved. * diff --git a/sql-jdbc/settings.gradle b/sql-jdbc/settings.gradle index ae072c6b5e..ee8ebc525f 100644 --- a/sql-jdbc/settings.gradle +++ b/sql-jdbc/settings.gradle @@ -1,3 +1,14 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + /* * Copyright <2019> Amazon.com, Inc. or its affiliates. All Rights Reserved. * From ab7733a6602b1f03b6a5140ec112a6ebbd9004ee Mon Sep 17 00:00:00 2001 From: Dai Date: Thu, 15 Apr 2021 16:56:36 -0700 Subject: [PATCH 10/15] Add issue template --- .github/ISSUE_TEMPLATE/bug_template.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_template.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md new file mode 100644 index 0000000000..42266a8358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -0,0 +1,38 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +Or for query issues: +1. Create the index with test documents by 'POST ...' +2. Run the query 'SELECT ...' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Plugins** +Please list all plugins currently enabled. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Host/Environment (please complete the following information):** + - OS: [e.g. iOS] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..2791b80819 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: 🎆 Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file From dcd9e8a9057d2f010b8a215cb8f394b45d950afb Mon Sep 17 00:00:00 2001 From: Dai Date: Fri, 16 Apr 2021 11:18:10 -0700 Subject: [PATCH 11/15] Add maintainers --- MAINTAINERS.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000000..7e42142eb2 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,13 @@ +# OpenSearch SQL Maintainers + +## Maintainers + +Here are the maintainer list for plugins and drivers (SQL/PPL, JDBC and ODBC): + +| Maintainer | GitHub ID | Affiliation | +| --------------- | --------- | ----------- | +| Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | +| Peng Huo | [penghuo](https://github.com/penghuo) | Amazon | +| Chloe | [chloe-zh](https://github.com/chloe-zh) | Amazon | +| Chen Dai | [dai-chen](https://github.com/dai-chen) | Amazon | +| Harold Wang | [harold-wang](https://github.com/harold-wang) | Amazon | From 8ebbb89a0547228c2dd32cd0abb98af12ae6cddc Mon Sep 17 00:00:00 2001 From: Dai Date: Fri, 16 Apr 2021 11:48:52 -0700 Subject: [PATCH 12/15] Update contributing --- CONTRIBUTING.md | 69 +++++++++++++++++++++------------------- sql-jdbc/CONTRIBUTING.md | 8 ++--- sql-odbc/CONTRIBUTING.md | 12 +++---- 3 files changed, 45 insertions(+), 44 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38ce000589..c16674bb01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](../../issues), or [recently closed](../../issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already +When filing an issue, please check [existing open](https://github.com/opensearch-project/sql/issues), or [recently closed](https://github.com/opensearch-project/sql/issues?q=is%3Aissue+is%3Aclosed), 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 @@ -20,50 +20,53 @@ reported the issue. Please try to include as much information as you can. Detail * 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 +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. + +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. + +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/). + ``` +Developer's Certificate of Origin 1.1 + 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 + 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 +(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. + 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 -``` -You can sign off your work easily by adding the configuration in github -``` -git config user.name "Bob Sanders" -git config user.email "bob.sanders@email.com" -``` -Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g. + 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. + ``` +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. + +Each commit must include a DCO which looks like this + ``` -git commit -s -m "my first commit" +Signed-off-by: Jane Smith ``` +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. ## 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 *master* branch. +1. You are working against the latest source on the *develop* 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. @@ -84,12 +87,12 @@ GitHub provides additional document on [forking a repository](https://help.githu For instructions for development in details, please refer to [Developer Guide](./DEVELOPER_GUIDE.rst). ## 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'](../../labels/help%20wanted) issues is a great place to start. +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'](https://github.com/opensearch-project/sql/issues?q=label%3A%22help+wanted%22) issues is a great place to start. ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications @@ -99,4 +102,4 @@ If you discover a potential security issue in this project we ask that you notif ## Licensing -See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/sql-jdbc/CONTRIBUTING.md b/sql-jdbc/CONTRIBUTING.md index 46d764bc31..1483d207e7 100644 --- a/sql-jdbc/CONTRIBUTING.md +++ b/sql-jdbc/CONTRIBUTING.md @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](../../../issues?q=is%3Aopen+is%3Aissue+label%3AJDBC), or [recently closed](../../../issues?q=is%3Aissue+is%3Aclosed+label%3AJDBC), issues to make sure somebody else hasn't already +When filing an issue, please check [existing open](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3AJDBC), or [recently closed](https://github.com/opensearch-project/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AJDBC), 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 @@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail ## 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 *master* branch. +1. You are working against the latest source on the *develop* 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. @@ -41,12 +41,12 @@ GitHub provides additional document on [forking a repository](https://help.githu ## 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?q=is%3Aopen+label%3A%22help+wanted%22+label%3AJDBC) issues is a great place to start. +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'](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3AJDBC) issues is a great place to start. ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications diff --git a/sql-odbc/CONTRIBUTING.md b/sql-odbc/CONTRIBUTING.md index 2cc7222a5c..c266a04d1a 100644 --- a/sql-odbc/CONTRIBUTING.md +++ b/sql-odbc/CONTRIBUTING.md @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aopen+is%3Aissue+label%3AODBC), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql/issues?q=is%3Aissue+is%3Aclosed+label%3AODBC), issues to make sure somebody else hasn't already +When filing an issue, please check [existing open](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3AODBC), or [recently closed](https://github.com/opensearch-project/sql/issues?q=is%3Aissue+is%3Aclosed), 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 @@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail ## 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 *master* branch. +1. You are working against the latest source on the *develop* 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. @@ -41,13 +41,11 @@ GitHub provides additional document on [forking a repository](https://help.githu ## 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?q=is%3Aopen+label%3A%22help+wanted%22+label%3AODBC) issues is a great place to start. +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'](https://github.com/opensearch-project/sql/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3AODBC) 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 -opensource-codeofconduct@amazon.com with any additional questions or comments. +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications @@ -56,6 +54,6 @@ If you discover a potential security issue in this project we ask that you notif ## Licensing -See the [LICENSE](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-odbc/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. From 70618cb66c0896bb6c64bd07c5389714de74b78c Mon Sep 17 00:00:00 2001 From: Dai Date: Fri, 16 Apr 2021 11:50:00 -0700 Subject: [PATCH 13/15] Update maintainers --- MAINTAINERS.md | 2 -- sql-jdbc/MAINTAINERS.md | 11 +++++++++++ sql-odbc/MAINTAINERS.md | 11 +++++++++++ 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 sql-jdbc/MAINTAINERS.md create mode 100644 sql-odbc/MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 7e42142eb2..a6f0a6a252 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -2,8 +2,6 @@ ## Maintainers -Here are the maintainer list for plugins and drivers (SQL/PPL, JDBC and ODBC): - | Maintainer | GitHub ID | Affiliation | | --------------- | --------- | ----------- | | Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | diff --git a/sql-jdbc/MAINTAINERS.md b/sql-jdbc/MAINTAINERS.md new file mode 100644 index 0000000000..ff390ab74f --- /dev/null +++ b/sql-jdbc/MAINTAINERS.md @@ -0,0 +1,11 @@ +# OpenSearch JDBC Maintainers + +## Maintainers + +| Maintainer | GitHub ID | Affiliation | +| --------------- | --------- | ----------- | +| Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | +| Peng Huo | [penghuo](https://github.com/penghuo) | Amazon | +| Chloe | [chloe-zh](https://github.com/chloe-zh) | Amazon | +| Chen Dai | [dai-chen](https://github.com/dai-chen) | Amazon | +| Harold Wang | [harold-wang](https://github.com/harold-wang) | Amazon | diff --git a/sql-odbc/MAINTAINERS.md b/sql-odbc/MAINTAINERS.md new file mode 100644 index 0000000000..59838756d9 --- /dev/null +++ b/sql-odbc/MAINTAINERS.md @@ -0,0 +1,11 @@ +# OpenSearch ODBC Maintainers + +## Maintainers + +| Maintainer | GitHub ID | Affiliation | +| --------------- | --------- | ----------- | +| Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | +| Peng Huo | [penghuo](https://github.com/penghuo) | Amazon | +| Chloe | [chloe-zh](https://github.com/chloe-zh) | Amazon | +| Chen Dai | [dai-chen](https://github.com/dai-chen) | Amazon | +| Harold Wang | [harold-wang](https://github.com/harold-wang) | Amazon | From ae30a335dce41a96f69ee319535fbddf22225307 Mon Sep 17 00:00:00 2001 From: Dai Date: Fri, 16 Apr 2021 11:55:56 -0700 Subject: [PATCH 14/15] Update contributing --- sql-jdbc/CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++++++++++ sql-odbc/CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) diff --git a/sql-jdbc/CONTRIBUTING.md b/sql-jdbc/CONTRIBUTING.md index 1483d207e7..1461eb76c9 100644 --- a/sql-jdbc/CONTRIBUTING.md +++ b/sql-jdbc/CONTRIBUTING.md @@ -19,6 +19,49 @@ reported the issue. Please try to include as much information as you can. Detail * Any modifications you've made relevant to the bug * Anything unusual about your environment or deployment +## Sign your work +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. + +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. + +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/). + +``` +Developer's Certificate of Origin 1.1 + +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. + ``` +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. + +Each commit must include a DCO which looks like this + +``` +Signed-off-by: Jane Smith +``` +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. ## Contributing via Pull Requests Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: diff --git a/sql-odbc/CONTRIBUTING.md b/sql-odbc/CONTRIBUTING.md index c266a04d1a..bd03ee53a7 100644 --- a/sql-odbc/CONTRIBUTING.md +++ b/sql-odbc/CONTRIBUTING.md @@ -19,6 +19,49 @@ reported the issue. Please try to include as much information as you can. Detail * Any modifications you've made relevant to the bug * Anything unusual about your environment or deployment +## Sign your work +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. + +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. + +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/). + +``` +Developer's Certificate of Origin 1.1 + +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. + ``` +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. + +Each commit must include a DCO which looks like this + +``` +Signed-off-by: Jane Smith +``` +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. ## Contributing via Pull Requests Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: From f65e2b0f40a8072da790b0e2dff9d30f4d099c81 Mon Sep 17 00:00:00 2001 From: Dai Date: Fri, 16 Apr 2021 15:38:13 -0700 Subject: [PATCH 15/15] Fix CoC link --- sql-jdbc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sql-jdbc/README.md b/sql-jdbc/README.md index 621421ee01..4a23ae99de 100644 --- a/sql-jdbc/README.md +++ b/sql-jdbc/README.md @@ -508,7 +508,7 @@ Please refer to the [documentation](https://opendistro.github.io/for-elasticsear ## Code of Conduct -This project has adopted an [Open Source Code of Conduct](../CODE_OF_CONDUCT.md). +This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md). ## Security issue notifications