Skip to content

Commit 51805ce

Browse files
peterzhuamazonpeterzhuamazon
committed
Add necessary documents before going public
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
1 parent a0f22c1 commit 51805ce

9 files changed

+163
-70
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @getsaurabh02 @peterzhuamazon

‎.github/ISSUE_TEMPLATE/bug_template.yaml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug Report
3+
description: File a bug report
4+
title: '[Bug]: '
5+
labels: [bug, untriaged]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: Describe the bug
15+
description: A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: to-Reproduce
20+
attributes:
21+
label: To reproduce
22+
description: Steps to reproduce the behavior
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: Expected-behaviour
27+
attributes:
28+
label: Expected behavior
29+
description: A clear and concise description of what you expected to happen.
30+
- type: textarea
31+
id: screenshots
32+
attributes:
33+
label: Screenshots
34+
description: Attach the screenshots associated with this issue
35+
value: If applicable, add screenshots to help explain your problem.
36+
- type: textarea
37+
id: Host-Environment
38+
attributes:
39+
label: Host / Environment
40+
description: Hosts / Environment information to reproduce this bug
41+
- type: textarea
42+
id: additional-context
43+
attributes:
44+
label: Additional context
45+
description: Add any other context about the problem here.
46+
- type: textarea
47+
id: logs
48+
attributes:
49+
label: Relevant log output
50+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
51+
render: shell

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature request
3+
description: Suggest an idea for this project
4+
labels: [enhancement, untriaged]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to submit a feature request!
10+
- type: textarea
11+
id: feature
12+
attributes:
13+
label: Is your feature request related to a problem? Please describe
14+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Describe the solution you'd like
21+
description: A clear and concise description of what you want to happen.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Describe alternatives you've considered
28+
description: A clear and concise description of any alternative solutions or features you've considered.
29+
- type: textarea
30+
id: additional-context
31+
attributes:
32+
label: Additional context
33+
description: Add any other context or screenshots about the feature request here.

‎ADMINS.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Admins
2+
3+
| Admin | GitHub ID | Affiliation |
4+
| --------------- | --------------------------------------- | ----------- |
5+
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
6+
7+
[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins do in this repo. and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).

‎CODE_OF_CONDUCT.md

+23-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
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-
opensource-codeofconduct@amazon.com 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, events, conferences, meetings, and any other communication channels used by the project.
2+
3+
**Our open source communities endeavor to:**
4+
5+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
6+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
7+
* 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.
8+
* 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.
9+
10+
**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:**
11+
12+
* The use of violent threats, abusive, discriminatory, or derogatory language;
13+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
14+
* Posting of sexually explicit or violent content;
15+
* The use of sexualized language and unwelcome sexual attention or advances;
16+
* Public or private harassment of any kind;
17+
* Publishing private information, such as physical or electronic address, without permission;
18+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
19+
* Advocating for or encouraging any of the above behaviors.
20+
21+
**Enforcement and Reporting Code of Conduct Issues:**
22+
23+
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.

‎CONTRIBUTING.md

+3-58
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,4 @@
1-
# Contributing Guidelines
1+
## Contributing to this Project
22

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.
5-
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.
8-
9-
10-
## Reporting Bugs/Feature Requests
11-
12-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13-
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:
16-
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
21-
22-
23-
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25-
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.
29-
30-
To send us a pull request, please:
31-
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.
38-
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/).
41-
42-
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.
45-
46-
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-
opensource-codeofconduct@amazon.com with any additional questions or comments.
51-
52-
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.
55-
56-
57-
## Licensing
58-
59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
3+
OpenSearch is a community project that is built and maintained by people just like **you**.
4+
[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.

‎MAINTAINERS.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
- [Overview](#overview)
2+
- [Current Maintainers](#current-maintainers)
3+
- [Emeritus](#emeritus)
4+
5+
## Overview
6+
7+
This document contains a list of maintainers in this repo. See [opensearch-project/.github/RESPONSIBILITIES.md](https://github.com/opensearch-project/.github/blob/main/RESPONSIBILITIES.md#maintainer-responsibilities) that explains what the role of maintainer means, what maintainers do in this and other repos, and how they should be doing it. If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](CONTRIBUTING.md).
8+
9+
## Current Maintainers
10+
11+
| Maintainer | GitHub ID | Affiliation |
12+
| ------------------ | --------------------------------------------------------- | ----------- |
13+
| Peter Zhu | [peterzhuamazon](https://github.com/peterzhuamazon) | Amazon |
14+
| Saurabh Sing | [getsaurabh02](https://github.com/getsaurabh02) | Amazon |
15+
16+
## Emeritus
17+
18+
| Maintainer | GitHub ID | Affiliation |
19+
| ------------------ | --------------------------------------------------------- | ----------- |

‎NOTICE

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
OpenSearch (https://opensearch.org/)
2+
Copyright OpenSearch Contributors

‎README.md

+24-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
1-
## My Project
1+
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">
22

3-
TODO: Fill this README out!
3+
- [Welcome!](#welcome)
4+
- [Project Resources](#project-resources)
5+
- [Code of Conduct](#code-of-conduct)
6+
- [Security](#security)
7+
- [License](#license)
8+
- [Copyright](#copyright)
9+
- [Trademark](#trademark)
410

5-
Be sure to:
11+
## Welcome!
612

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
13+
This repository hosts the source code of an automation app to handle the daily activities of your GitHub Repository.
14+
15+
## Project Resources
16+
17+
The automation app utilizes the [Probot](https://probot.github.io/) framework and [Octokit](https://docs.github.com/en/rest/using-the-rest-api/libraries-for-the-rest-api?apiVersion=2022-11-28) library to perform user-defined operations on top of the resources within GitHub. See [configs](configs/operations/hello-world.yml) yaml for more information.
18+
19+
## Code of Conduct
20+
21+
This project has adopted [the Open Source Code of Conduct](CODE_OF_CONDUCT.md).
922

1023
## Security
1124

12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
25+
If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue.
1326

1427
## License
1528

16-
This project is licensed under the Apache-2.0 License.
29+
This project is licensed under the [Apache v2.0 License](LICENSE).
30+
31+
## Copyright
32+
33+
Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.
1734

0 commit comments

Comments
 (0)