Skip to content

Commit 3486d76

Browse files
authored
Standardize files with OpenSearch files contents (#11)
* Standardize files with OpenSearch files contents Standardize following files 1. NOTICE.txt, 2. MAINTAINERS.md, 3. CONTRIBUTING.md 4. CODE_OF_CONDUCT.md 5. DEVELOPER_GUIDE.md 6. LICENSE.txt Signed-off-by: Vijayan Balasubramanian <[email protected]>
1 parent 2fbf2e4 commit 3486d76

9 files changed

+335
-43
lines changed
+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Execute following commands '...'
15+
2. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Host/Environment (please complete the following information):**
24+
- OS: [e.g. macOS]
25+
- Version [e.g. 1.0.0]
26+
27+
**Additional context**
28+
Add any other context about the problem here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: 🎆 Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Description
2+
[Describe what this change achieves]
3+
4+
### Issues Resolved
5+
[List any issues this PR will resolve]
6+
7+
### Check List
8+
- [ ] New functionality includes testing.
9+
- [ ] All tests pass
10+
- [ ] New functionality has been documented.
11+
- [ ] New functionality has javadoc added
12+
- [ ] Commits are signed as per the DCO using --signoff
13+
14+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
15+
For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opnesearch-cli/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

CODE_OF_CONDUCT.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4-
[email protected] with any additional questions or comments.
1+
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.
2+
3+
4+
**Our open source communities endeavor to:**
5+
6+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
7+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
8+
* 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.
9+
* 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.
10+
11+
12+
**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:**
13+
14+
* The use of violent threats, abusive, discriminatory, or derogatory language;
15+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
16+
* Posting of sexually explicit or violent content;
17+
* The use of sexualized language and unwelcome sexual attention or advances;
18+
* Public or private harassment of any kind;
19+
* Publishing private information, such as physical or electronic address, without permission;
20+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
21+
* Advocating for or encouraging any of the above behaviors.
22+
* Enforcement and Reporting Code of Conduct Issues:
23+
24+
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.

CONTRIBUTING.md

+91-38
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,114 @@
1-
# Contributing Guidelines
1+
Contributing to OpenSearch CLI
2+
=============================
23

3-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4-
documentation, we greatly value feedback and contributions from our community.
4+
OpenSearch CLI is a community project that is built and maintained by people just like **you**. We're glad you're interested in helping out. There are several different ways you can do it, but before we talk about that, let's talk about how to get started.
55

6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7-
information to effectively respond to your bug report or contribution.
6+
## Table of Contents:
7+
- [First Things First](#first-things-first)
8+
- [Ways to Contribute](#ways-to-contribute)
9+
- [Developer Certificate of Origin](#developer-certificate-of-origin)
10+
- [Review Process](#review-process)
811

912

10-
## Reporting Bugs/Feature Requests
13+
## First Things First
1114

12-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
15+
1. **When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when it doubt, [open an issue](https://github.com/opensearch-project/opensearch-cli/issues).
1316

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
17+
2. **Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll
18+
use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
1619

17-
* A reproducible test case or series of steps
18-
* The version of our code being used
19-
* Any modifications you've made relevant to the bug
20-
* Anything unusual about your environment or deployment
20+
## Ways to Contribute
2121

22+
### Bug Reports
2223

23-
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
24+
Ugh! Bugs!
2525

26-
1. You are working against the latest source on the *main* branch.
27-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
26+
A bug is when software behaves in a way that you didn't expect and the developer didn't intend. To help us understand what's going on, we first want to make sure you're working from the latest version. Please make sure you're testing against the [latest version](https://github.com/opensearch-project/opensearch-cli).
2927

30-
To send us a pull request, please:
28+
Once you've confirmed that the bug still exists in the latest version, you'll want to check to make sure it's not something we already know about on the [open issues GitHub page](https://github.com/opensearch-project/opensearch-cli/issues).
3129

32-
1. Fork the repository.
33-
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34-
3. Ensure local tests pass.
35-
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
30+
If you've upgraded to the latest version and you can't find it in our open issues list, then you'll need to tell us how to reproduce it. To make the behavior as clear as possible, please provided your steps as `opensearch-cli` commands which we can copy and paste into a terminal to run it locally, for example:
3831

39-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40-
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
32+
```sh
33+
# delete the index
34+
opensearch-cli curl delete --path "test"
4135

36+
# insert a document
37+
opensearch-cli curl put --path "test/test/1" -d '{
38+
"title": "test document"
39+
}'
4240

43-
## Finding contributions to work on
44-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
41+
# this should return XXXX but instead returns YYYY
42+
opensearch-cli ....
43+
```
4544

45+
Provide as much information as you can. You may think that the problem lies with your query, when actually it depends on how your data is indexed. The easier it is for us to recreate your problem, the faster it is likely to be fixed.
4646

47-
## Code of Conduct
48-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50-
[email protected] with any additional questions or comments.
47+
### Feature Requests
5148

49+
If you've thought of a way that OpenSearch CLI could be better, we want to hear about it. We track feature requests using GitHub, so please feel free to open an issue which describes the feature you would like to see, why you need it, and how it should work.
5250

53-
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
51+
### Documentation Changes
5552

53+
//TODO
5654

57-
## Licensing
55+
### Contributing Code
5856

59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
57+
As with other types of contributions, the first step is to [**open an issue on GitHub**](https://github.com/opensearch-project/opensearch-cli/issues/new/choose). Opening an issue before you make changes makes sure that someone else isn't already working on that particular problem. It also lets us all work together to find the right approach before you spend a bunch of time on a PR. So again, when in doubt, open an issue.
6058

61-
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
59+
Once you've opened an issue, check out our [Developer Guide](./DEVELOPER_GUIDE.md) for instructions on how to get started.
60+
61+
## Developer Certificate of Origin
62+
63+
OpenSearch CLI 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.
64+
65+
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.
66+
67+
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/).
68+
69+
```
70+
Developer's Certificate of Origin 1.1
71+
72+
By making a contribution to this project, I certify that:
73+
74+
(a) The contribution was created in whole or in part by me and I
75+
have the right to submit it under the open source license
76+
indicated in the file; or
77+
78+
(b) The contribution is based upon previous work that, to the
79+
best of my knowledge, is covered under an appropriate open
80+
source license and I have the right under that license to
81+
submit that work with modifications, whether created in whole
82+
or in part by me, under the same open source license (unless
83+
I am permitted to submit under a different license), as
84+
Indicated in the file; or
85+
86+
(c) The contribution was provided directly to me by some other
87+
person who certified (a), (b) or (c) and I have not modified
88+
it.
89+
90+
(d) I understand and agree that this project and the contribution
91+
are public and that a record of the contribution (including
92+
all personal information I submit with it, including my
93+
sign-off) is maintained indefinitely and may be redistributed
94+
consistent with this project or the open source license(s)
95+
involved.
96+
```
97+
We require that every contribution to OpenSearch CLI is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
98+
99+
Each commit must include a DCO which looks like this
100+
101+
```
102+
Signed-off-by: Jane Smith <[email protected]>
103+
```
104+
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.
105+
106+
## Review Process
107+
108+
We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/opensearch-cli/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction.
109+
110+
During the PR process, expect that there will be some back-and-forth. Please try to respond to comments in a timely fashion, and if you don't wish to continue with the PR, let us know. If a PR takes too many iterations for its complexity or size, we may reject it. Additionally, if you stop responding we may close the PR as abandoned. In either case, if you feel this was done in error, please add a comment on the PR.
111+
112+
If we accept the PR, we will merge your change and usually take care of backporting it to appropriate branches ourselves.
113+
114+
If we reject the PR, we will close the pull request with a comment explaining why. This decision isn't always final: if you feel we have misunderstood your intended change or otherwise think that we should reconsider then please continue the conversation with a comment on the PR and we'll do our best to address any further points you raise.

0 commit comments

Comments
 (0)