Skip to content

Commit 31494c6

Browse files
VijayanBVijayanB
committed
Copy basic template files
Copied OpenSearch repository template files. Signed-off-by: Vijayan Balasubramanian <[email protected]>
1 parent 99d60b7 commit 31494c6

13 files changed

+364
-366
lines changed

‎.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG]'
5+
labels: 'bug, untriaged'
6+
assignees: ''
7+
---
8+
9+
**What is the bug?**
10+
A clear and concise description of the bug.
11+
12+
**How can one reproduce the bug?**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**What is the expected behavior?**
20+
A clear and concise description of what you expected to happen.
21+
22+
**What is your host/environment?**
23+
- OS: [e.g. iOS]
24+
- Version [e.g. 22]
25+
- Plugins
26+
27+
**Do you have any screenshots?**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Do you have any additional context?**
31+
Add any other context about the problem.

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🎆 Feature request
3+
about: Request a feature in this project
4+
title: '[FEATURE]'
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
**Is your feature request related to a problem?**
9+
A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_
10+
11+
**What solution would you like?**
12+
A clear and concise description of what you want to happen.
13+
14+
**What alternatives have you considered?**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Do you have any additional context?**
18+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 💭 Proposal
3+
about: Suggest an idea for a specific feature you wish to propose to the community for comment
4+
title: '[PROPOSAL]'
5+
labels: proposal
6+
assignees: ''
7+
---
8+
## What kind of business use case are you trying to solve? What are your requirements?
9+
A clear and concise description of the business problem, e.g. _My customers are asking for [...]_
10+
11+
**What is the problem? What is preventing you from meeting the requirements?**
12+
Describe what impact this problem has for lack of a solution.
13+
14+
**What are you proposing? What do you suggest we do to solve the problem or improve the existing situation?**
15+
Describe your proposed solution. It's OK if you don't have one.
16+
17+
**What are your assumptions or prerequisites?**
18+
Describe any assumptions you may be making that would limit the scope of this proposal.
19+
20+
**What are remaining open questions?**
21+
List questions that may need to be answered before proceeding with an implementation.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: OpenSearch Community Support
3+
url: https://discuss.opendistrocommunity.dev/
4+
about: Please ask and answer questions here.
5+
- name: AWS/Amazon Security
6+
url: https://aws.amazon.com/security/vulnerability-reporting/
7+
about: Please report security vulnerabilities here.

‎ADMINS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Overview
2+
3+
This document explains who the admins are (see below), what they do in this repo, and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
4+
5+
## Current Admins
6+
7+
| Admin | GitHub ID | Affiliation |
8+
| -------------------------| --------------------------------------- | ----------- |
9+
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
10+
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
11+
12+
13+
## Admin Responsibilities
14+
15+
As an admin you own stewartship of the repository and its settings. Admins have [admin-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and protect the repository as follows.
16+
17+
### Prioritize Security
18+
19+
Security is your number one priority. Manage security keys and safeguard access to the repository.
20+
21+
Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.
22+
23+
### Enforce Code of Conduct
24+
25+
Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and blocking malicious actors.
26+
27+
### Adopt Organizational Best Practices
28+
29+
Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.

‎CODE_OF_CONDUCT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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.

‎CONTRIBUTING.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
- [Contributing to OpenSearch](#contributing-to-opensearch)
2+
- [First Things First](#first-things-first)
3+
- [Ways to Contribute](#ways-to-contribute)
4+
- [Bug Reports](#bug-reports)
5+
- [Feature Requests](#feature-requests)
6+
- [Contributing Code](#contributing-code)
7+
- [Developer Certificate of Origin](#developer-certificate-of-origin)
8+
- [Review Process](#review-process)
9+
10+
## Contributing to OpenSearch
11+
12+
OpenSearch 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.
13+
14+
## First Things First
15+
16+
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](issues).
17+
18+
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 use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
19+
20+
## Ways to Contribute
21+
22+
### Bug Reports
23+
24+
Ugh! Bugs!
25+
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.
27+
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](issues).
29+
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 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.
31+
32+
### Feature Requests
33+
34+
If you've thought of a way that OpenSearch 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.
35+
36+
37+
### Contributing Code
38+
39+
As with other types of contributions, the first step is to [open an issue on GitHub](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.
40+
41+
## Developer Certificate of Origin
42+
43+
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.
44+
45+
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.
46+
47+
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/).
48+
49+
```
50+
Developer's Certificate of Origin 1.1
51+
52+
By making a contribution to this project, I certify that:
53+
54+
(a) The contribution was created in whole or in part by me and I
55+
have the right to submit it under the open source license
56+
indicated in the file; or
57+
58+
(b) The contribution is based upon previous work that, to the
59+
best of my knowledge, is covered under an appropriate open
60+
source license and I have the right under that license to
61+
submit that work with modifications, whether created in whole
62+
or in part by me, under the same open source license (unless
63+
I am permitted to submit under a different license), as
64+
Indicated in the file; or
65+
66+
(c) The contribution was provided directly to me by some other
67+
person who certified (a), (b) or (c) and I have not modified
68+
it.
69+
70+
(d) I understand and agree that this project and the contribution
71+
are public and that a record of the contribution (including
72+
all personal information I submit with it, including my
73+
sign-off) is maintained indefinitely and may be redistributed
74+
consistent with this project or the open source license(s)
75+
involved.
76+
```
77+
78+
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.
79+
80+
Each commit must include a DCO which looks like this
81+
82+
```
83+
Signed-off-by: Jane Smith <[email protected]>
84+
```
85+
86+
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.
87+
88+
## Review Process
89+
90+
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](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.
91+
92+
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.
93+
94+
If we accept the PR, a [maintainer](MAINTAINERS.md) will merge your change and usually take care of backporting it to appropriate branches ourselves.
95+
96+
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.

‎LICENSE renamed to ‎LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2018 Elasticsearch BV
189+
Copyright [yyyy] [name of copyright owner]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

‎MAINTAINERS.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
- [Overview](#overview)
2+
- [Current Maintainers](#current-maintainers)
3+
- [Maintainer Responsibilities](#maintainer-responsibilities)
4+
- [Uphold Code of Conduct](#uphold-code-of-conduct)
5+
- [Prioritize Security](#prioritize-security)
6+
- [Review Pull Requests](#review-pull-requests)
7+
- [Triage Open Issues](#triage-open-issues)
8+
- [Be Responsive](#be-responsive)
9+
- [Maintain Overall Health of the Repo](#maintain-overall-health-of-the-repo)
10+
- [Use Semver](#use-semver)
11+
- [Release Frequently](#release-frequently)
12+
- [Promote Other Maintainers](#promote-other-maintainers)
13+
14+
## Overview
15+
16+
This document explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
17+
18+
## Current Maintainers
19+
20+
| Maintainer | GitHub ID | Affiliation |
21+
| ------------------------ | --------------------------------------- | ----------- |
22+
| Jack Mazanec | [jmazanec15](https://github.com/jmazanec15) | Amazon |
23+
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
24+
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
25+
26+
## Maintainer Responsibilities
27+
28+
Maintainers are active and visible members of the community, and have [maintain-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and evolve code as follows.
29+
30+
### Uphold Code of Conduct
31+
32+
Model the behavior set forward by the [Code of Conduct](CODE_OF_CONDUCT.md) and raise any violations to other maintainers and admins.
33+
34+
### Prioritize Security
35+
36+
Security is your number one priority. Maintainer's Github keys must be password protected securely and any reported security vulnerabilities are addressed before features or bugs.
37+
38+
Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.
39+
40+
### Review Pull Requests
41+
42+
Review pull requests regularly, comment, suggest, reject, merge and close. Accept only high quality pull-requests. Provide code reviews and guidance on incomming pull requests. Don't let PRs be stale and do your best to be helpful to contributors.
43+
44+
### Triage Open Issues
45+
46+
Manage labels, review issues regularly, and triage by labelling them.
47+
48+
All repositories in this organization have a standard set of labels, including `bug`, `documentation`, `duplicate`, `enhancement`, `good first issue`, `help wanted`, `blocker`, `invalid`, `question`, `wontfix`, and `untriaged`, along with release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`, and `backport`.
49+
50+
Use labels to target an issue or a PR for a given release, add `help wanted` to good issues for new community members, and `blocker` for issues that scare you or need immediate attention. Request for more information from a submitter if an issue is not clear. Create new labels as needed by the project.
51+
52+
### Be Responsive
53+
54+
Respond to enhancement requests, and forum posts. Allocate time to reviewing and commenting on issues and conversations as they come in.
55+
56+
### Maintain Overall Health of the Repo
57+
58+
Keep the `main` branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches.
59+
60+
### Use Semver
61+
62+
Use and enforce [semantic versioning](https://semver.org/) and do not let breaking changes be made outside of major releases.
63+
64+
### Release Frequently
65+
66+
Make frequent project releases to the community.
67+
68+
### Promote Other Maintainers
69+
70+
Assist, add, and remove [MAINTAINERS](MAINTAINERS.md). Exercise good judgement, and propose high quality contributors to become co-maintainers.

0 commit comments

Comments
 (0)