Skip to content

Commit 0067d17

Browse files
authored
Update base docs and license; Add issue and PR templates (opensearch-project#5)
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
1 parent 9050115 commit 0067d17

10 files changed

+119
-32
lines changed
+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Plugins**
24+
Please list all plugins currently enabled.
25+
26+
**Screenshots**
27+
If applicable, add screenshots to help explain your problem.
28+
29+
**Host/Environment (please complete the following information):**
30+
31+
- OS: [e.g. iOS]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.
+19
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

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Description
2+
3+
[Describe what this change achieves]
4+
5+
### Issues Resolved
6+
7+
[List any issues this PR will resolve]
8+
9+
### Check List
10+
11+
- [ ] New functionality includes testing.
12+
- [ ] All tests pass
13+
- [ ] New functionality has been documented.
14+
- [ ] Commits are signed per the DCO using `--signoff`
15+
16+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
17+
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).

CODE_OF_CONDUCT.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
## Code of Conduct
2-
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html).
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+
**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+
- Enforcement and Reporting Code of Conduct Issues:
21+
22+
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

-6
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ GitHub provides additional document on [forking a repository](https://help.githu
4242

4343
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/anomaly-detection-dashboards-plugin/labels/help%20wanted) issues is a great place to start.
4444

45-
## Code of Conduct
46-
47-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
48-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
49-
opensource-codeofconduct@amazon.com with any additional questions or comments.
50-
5145
## Security issue notifications
5246

5347
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.

CONTRIBUTORS

-20
This file was deleted.

LICENSE.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Apache License
32
Version 2.0, January 2004
43
http://www.apache.org/licenses/

MAINTAINERS.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# OpenSearch Anomaly Detection Dashboards Maintainers
2+
3+
## Maintainers
4+
5+
| Maintainer | GitHub ID | Affiliation |
6+
| ----------------------- | ------------------------------------------------------- | ----------- |
7+
| Tyler Ohlsen | [ohltyler](https://github.com/ohltyler) | Amazon |
8+
| Yaliang | [ylwu-amzn](https://github.com/ylwu-amzn) | Amazon |
9+
| Yizhe Liu | [yizheliu-amazon](https://github.com/yizheliu-amazon) | Amazon |
10+
| Nick Knize | [nknize](https://github.com/nknize) | Amazon |
11+
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
12+
| Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli) | Amazon |
13+
| Weicong Sun | [weicongs-amazon](https://github.com/weicongs-amazon) | Amazon |
14+
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |

NOTICE.txt

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
OpenSearch Anomaly Detection
2-
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
OpenSearch
2+
Copyright 2021 OpenSearch Contributors
3+
4+
This product includes software developed by
5+
Elasticsearch (http://www.elastic.co).
6+
Copyright 2009-2018 Elasticsearch
7+
8+
This product includes software developed by The Apache Software
9+
Foundation (http://www.apache.org/).
10+
11+
This product includes software developed by
12+
Joda.org (http://www.joda.org/).

OWNERS

-1
This file was deleted.

0 commit comments

Comments
 (0)