You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[ ] All tests pass, including unit test, integration test and doctest
10
+
-[ ] New functionality has been documented.
11
+
-[ ] New functionality has javadoc added
12
+
-[ ] New functionality has user manual doc added
13
+
-[ ] Commits are signed per the DCO using --signoff
2
14
3
-
*Description of changes:*
4
-
5
-
6
-
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
15
+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
16
+
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).
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html).
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:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+37-34
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
11
11
12
12
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
13
14
-
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
14
+
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
15
15
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
16
17
17
* 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
20
20
* Anything unusual about your environment or deployment
21
21
22
22
## Sign your work
23
-
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
23
+
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.
24
+
25
+
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.
26
+
27
+
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/).
28
+
24
29
```
30
+
Developer's Certificate of Origin 1.1
31
+
25
32
By making a contribution to this project, I certify that:
26
33
27
34
(a) The contribution was created in whole or in part by me and I
28
-
have the right to submit it under the open source license
29
-
indicated in the file; or
35
+
have the right to submit it under the open source license
36
+
indicated in the file; or
30
37
31
-
(b) The contribution is based upon previous work that, to the best
32
-
of my knowledge, is covered under an appropriate open source
33
-
license and I have the right under that license to submit that
34
-
work with modifications, whether created in whole or in part
35
-
by me, under the same open source license (unless I am
36
-
permitted to submit under a different license), as indicated
37
-
in the file; or
38
+
(b) The contribution is based upon previous work that, to the
39
+
best of my knowledge, is covered under an appropriate open
40
+
source license and I have the right under that license to
41
+
submit that work with modifications, whether created in whole
42
+
or in part by me, under the same open source license (unless
43
+
I am permitted to submit under a different license), as
44
+
Indicated in the file; or
38
45
39
46
(c) The contribution was provided directly to me by some other
40
-
person who certified (a), (b) or (c) and I have not modified
41
-
it.
47
+
person who certified (a), (b) or (c) and I have not modified
48
+
it.
42
49
43
50
(d) I understand and agree that this project and the contribution
44
-
are public and that a record of the contribution (including all
45
-
personal information I submit with it, including my sign-off) is
46
-
maintained indefinitely and may be redistributed consistent with
47
-
this project or the open source license(s) involved.
48
-
```
49
-
then you just add a line to every git commit message:
Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g.
51
+
are public and that a record of the contribution (including
52
+
all personal information I submit with it, including my
53
+
sign-off) is maintained indefinitely and may be redistributed
54
+
consistent with this project or the open source license(s)
55
+
involved.
56
+
```
57
+
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.
58
+
59
+
Each commit must include a DCO which looks like this
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.
62
65
63
66
## Contributing via Pull Requests
64
67
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
65
68
66
-
1. You are working against the latest source on the *master* branch.
69
+
1. You are working against the latest source on the *develop* branch.
67
70
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
68
71
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
69
72
@@ -81,15 +84,15 @@ GitHub provides additional document on [forking a repository](https://help.githu
81
84
82
85
## Developing
83
86
84
-
For instructions for development in details, please refer to [Development Guide](./docs/developing.rst).
87
+
For instructions for development in details, please refer to [Developer Guide](./DEVELOPER_GUIDE.rst).
85
88
86
89
## Finding contributions to work on
87
-
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.
90
+
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.
88
91
89
92
90
93
## Code of Conduct
91
94
92
-
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html).
95
+
This project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md).
93
96
94
97
95
98
## Security issue notifications
@@ -99,4 +102,4 @@ If you discover a potential security issue in this project we ask that you notif
99
102
100
103
## Licensing
101
104
102
-
See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
105
+
See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
Copy file name to clipboardexpand all lines: README.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -23,8 +23,7 @@ The following projects have been merged into this repository as separate folders
23
23
24
24
## Documentation
25
25
26
-
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 plugin. Looking to contribute? Read the instructions on [Development Guide](./docs/developing.rst) and then submit a patch!
27
-
26
+
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 plugin. Looking to contribute? Read the instructions on [Developer Guide](./DEVELOPER_GUIDE.rst) and then submit a patch!
0 commit comments