Standardize processes across all plugins - Checklist items (#26)

* Add RELEASING.md file * Fix broken codecov * Adding broken links check using github actions * Update and add documentation files Signed-off-by: Sruti Parthiban <[email protected]> * Cleanup templates Signed-off-by: Sruti Parthiban <[email protected]> * Fix broken link in README
opensearch-project · Jun 29, 2021 · 12f9342 · 12f9342
1 parent 2947720
commit 12f9342
Show file tree

Hide file tree

Showing 14 changed files with 165 additions and 214 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
@@ -0,0 +1,31 @@
+---
+name: 🐛 Bug report
+about: Create a report to help us improve
+title: '[BUG]'
+labels: 'bug, untriaged'
+assignees: ''
+---
+
+**What is the bug?**
+A clear and concise description of the bug.
+
+**How can one reproduce the bug?**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**What is the expected behavior?**
+A clear and concise description of what you expected to happen.
+
+**What is your host/environment?**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+ - Plugins
+
+**Do you have any screenshots?**
+If applicable, add screenshots to help explain your problem.
+
+**Do you have any additional context?**
+Add any other context about the problem.
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+---
+name: 🎆 Feature request
+about: Request a feature in this project
+title: '[FEATURE]'
+labels: enhancement
+assignees: ''
+---
+**Is your feature request related to a problem?**
+A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_
+
+**What solution would you like?**
+A clear and concise description of what you want to happen.
+
+**What alternatives have you considered?**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Do you have any additional context?**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md b/.github/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/bug_template.md b/.github/bug_template.md
diff --git a/.github/feature_request_template.md b/.github/feature_request_template.md
diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
@@ -0,0 +1,23 @@
+name: Link Checker
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  linkchecker:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: lychee Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@master
+        with:
+          args: --accept=200,403,429  "**/*.html" "**/*.md" "**/*.txt" "**/*.json"
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Fail if there were link errors
+        run: exit ${{ steps.lychee.outputs.exit_code }}
diff --git a/ADMINS.md b/ADMINS.md
@@ -0,0 +1,8 @@
+## Admins
+
+| Admin           | GitHub ID                               | Affiliation |
+| --------------- | --------------------------------------- | ----------- |
+| Charlotte       | [CEHENKLE](https://github.com/CEHENKLE) | Amazon      |
+| Henri Yandell   | [hyandell](https://github.com/hyandell) | Amazon      |
+
+[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).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,101 +1,2 @@
-# Contributing Guidelines
-
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
-documentation, we greatly value feedback and contributions from our community.
-
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
-information to effectively respond to your bug report or contribution.
-
-
-## Reporting Bugs/Feature Requests
-
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
-
-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
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
-
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
-
-## Contributing via Pull Requests
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
-
-1. You are working against the latest source on the *main* branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
-
-To send us a pull request, please:
-
-1. Fork the repository.
-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.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
-[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
-
-## Developer Certificate of Origin
-
-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.
-
-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/).
-
-```
-Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the
-    best of my knowledge, is covered under an appropriate open
-    source license and I have the right under that license to
-    submit that work with modifications, whether created in whole
-    or in part by me, under the same open source license (unless
-    I am permitted to submit under a different license), as
-    Indicated in the file; or
-
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including
-    all personal information I submit with it, including my
-    sign-off) is maintained indefinitely and may be redistributed
-    consistent with this project or the open source license(s)
-    involved.
- ```
-We require that every contribution is signed with a Developer Certificate of Origin.  Additionally, please use your real name.  We do not accept anonymous contributors nor those utilizing pseudonyms.
-
-Each commit must include a DCO which looks like this
-
-```
-Signed-off-by: Jane Smith <[email protected]>
-```
-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.
-
-## Finding contributions to work on
-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.
-
-
-## Code of Conduct
-
-This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html).
-
-
-## Security issue notifications
-
-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.
-
-
-## Licensing
-
-See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+OpenSearch is a community project that is built and maintained by people just like **you**.
+[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -0,0 +1,39 @@
+- [Developer Guide](#developer-guide)
+  - [Forking and Cloning](#forking-and-cloning)
+  - [Install Prerequisites](#install-prerequisites)
+    - [JDK 14](#jdk-14)
+  - [Building](#building)
+  - [Using IntelliJ IDEA](#using-intellij-idea)
+  - [Submitting Changes](#submitting-changes)
+
+## Developer Guide
+
+So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.
+
+### Forking and Cloning
+
+Fork this repository on GitHub, and clone locally with `git clone`.
+
+### Install Prerequisites
+
+#### JDK 14
+
+OpenSearch components build using Java 14 at a minimum. This means you must have a JDK 14 installed with the environment variable `JAVA_HOME` referencing the path to Java home for your JDK 14 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-14`.
+
+### Building
+
+To build from the command line, use `./gradlew`.
+
+```
+./gradlew clean
+./gradlew build
+./gradlew publishToMavenLocal
+```
+
+### Using IntelliJ IDEA
+
+Launch Intellij IDEA, choose **Import Project**, and select the `build.gradle` file in the root of this package. 
+
+### Submitting Changes
+
+See [CONTRIBUTING](CONTRIBUTING.md).
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,14 +1,12 @@
-# Performance Analyzer Maintainers
+# OpenSearch Performance Analyzer Maintainers
 
 ## Maintainers
-| Maintainer | GitHub ID | Affiliation |
-| --------------- | --------- | ----------- |
-| Joshua Tokle  | [jotok](https://github.com/jotok) | Amazon |
-| Sruti Parthiban  | [sruti1312](https://github.com/sruti1312) | Amazon |
-| Haoru Xiao  | [hxiao608](https://github.com/hxiao608) | Amazon |
-| Ricardo L. Stephen | [ricardolstephen](https://github.com/ricardolstephen) | Amazon |
-| Yujia Sun   | [yujias0706](https://github.com/yujias0706) | Amazon |
-| Kunal Khatua | [kkhatua](https://github.com/kkhatua) | Amazon |
+| Maintainer              | GitHub ID                                               | Affiliation |
+| ----------------------- | ------------------------------------------------------- | ----------- |
+| Joshua Tokle            | [jotok](https://github.com/jotok)                       | Amazon      |
+| Kunal Khatua            | [kkhatua](https://github.com/kkhatua)                   | Amazon      |
+| Ruizhen Guo             | [rguo-aws](https://github.com/rguo-aws)                 | Amazon      |
+| Sruti Parthiban         | [sruti1312](https://github.com/sruti1312)               | Amazon      |
+| Yujia Sun               | [yujias0706](https://github.com/yujias0706)             | Amazon      |
 
-
-**Note:** Affiliations are tracked as during time of their contributions, and might be out-of-date.
+[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).