Removed pre-alpha notes. (#815)
Signed-off-by: dblock <dblock@amazon.com>
This commit is contained in:
Daniel Doubrovkine (dB.)
GitHub
parent
3c92080ce4
commit
6a8e303591
|
|
@ -1,25 +1,26 @@
|
|||
Contributing to OpenSearch
|
||||
=============================
|
||||
|
||||
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.
|
||||
|
||||
## Table of Contents:
|
||||
- [Contributing to OpenSearch](#contributing-to-opensearch)
|
||||
- [First Things First](#first-things-first)
|
||||
- [Ways to Contribute](#ways-to-contribute)
|
||||
- [Bug Reports](#bug-reports)
|
||||
- [Feature Requests](#feature-requests)
|
||||
- [Documentation Changes](#documentation-changes)
|
||||
- [Contributing Code](#contributing-code)
|
||||
- [Developer Certificate of Origin](#developer-certificate-of-origin)
|
||||
- [Review Process](#review-process)
|
||||
|
||||
# Contributing to OpenSearch
|
||||
|
||||
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.
|
||||
|
||||
## First Things First
|
||||
|
||||
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/issues).
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
## Ways to Contribute
|
||||
|
||||
**Please note:** OpenSearch is a fork of [Elasticsearch 7.10.2](https://github.com/elastic/elasticsearch), and is currently in a pre-alpha state, so it's still very much a work in progress. If you do find references to Elasticsearch (outside of attributions and copyrights!) please [open an issue](https://github.com/opensearch-project/OpenSearch/issues)
|
||||
**Please note:** OpenSearch is a fork of [Elasticsearch 7.10.2](https://github.com/elastic/elasticsearch), and is work in progress. If you do find references to Elasticsearch (outside of attributions and copyrights!) please [open an issue](https://github.com/opensearch-project/OpenSearch/issues).
|
||||
|
||||
### Bug Reports
|
||||
|
||||
|
|
@ -52,8 +53,7 @@ If you've thought of a way that OpenSearch could be better, we want to hear abou
|
|||
|
||||
### Documentation Changes
|
||||
|
||||
If you would like to contribute to the documentation, please see [OpenSearch Docs repo](https://github.com/opensearch-project/documentation-website/blob/main/README.md).
|
||||
To contribute javadocs, please see [this open issue on github](https://github.com/opensearch-project/OpenSearch/issues/221).
|
||||
If you would like to contribute to the documentation, please see [OpenSearch Docs repo](https://github.com/opensearch-project/documentation-website/blob/main/README.md). To contribute javadocs, please see [this open issue on github](https://github.com/opensearch-project/OpenSearch/issues/221).
|
||||
|
||||
### Contributing Code
|
||||
|
||||
|
|
|
|||
|
|
@ -89,8 +89,6 @@ BUILD SUCCESSFUL in 14m 50s
|
|||
2587 actionable tasks: 2450 executed, 137 up-to-date
|
||||
```
|
||||
|
||||
**Note: OpenSearch hasn't made any changes to the test suite yet, beyond fixing tests that broke after removing non-Apache licensed code and non-Apache licensed code checks. Also, while we're in pre-alpha, some tests may be failing until we finish the forking process. We should have an issue for all failing tests, but if you find one first, feel free to open one (and fix it :) ).**
|
||||
|
||||
If the full test suite fails you may want to start with a smaller set.
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -2,20 +2,18 @@
|
|||
|
||||
Hello!
|
||||
|
||||
OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2, and is currently in an alpha state. While we're still in the process of getting set up, we are excited to build the best distributed search engine on the planet with you.
|
||||
OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2. We are excited to build the best distributed search engine on the planet with you!
|
||||
|
||||
We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache 2.0 compliant code and doing a full rename of the project. Feel free to take a look around at what we've been up to, and then head over to look at the [open issues](https://github.com/opensearch-project/OpenSearch/issues). Or you could jump right in and [start opening issues](https://github.com/opensearch-project/OpenSearch/issues/new/choose) or [contributing](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md).
|
||||
We officially began work on the new fork on January 21st, 2021. Since then, we've removed non-Apache 2.0 compliant code and did a full rename of the project. Feel free to take a look around at what we've been up to, and then head over to look at the [open issues](https://github.com/opensearch-project/OpenSearch/issues). Or you could jump right in and [start opening issues](https://github.com/opensearch-project/OpenSearch/issues/new/choose) or [contributing](CONTRIBUTING.md).
|
||||
|
||||
## Getting Started
|
||||
|
||||
If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html).
|
||||
If you would like to build, install and run this project please see the [Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md).
|
||||
If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html). If you would like to build, install and run this project please see the [Developer Guide](DEVELOPER_GUIDE.md).
|
||||
|
||||
## Guiding Principles
|
||||
|
||||
Here are the principles we use to guide our development. From [opensearch.org](http://opensearch.org):
|
||||
|
||||
|
||||
> When we (the contributors) are successful, the OpenSearch project will be:
|
||||
>
|
||||
>**1. Great software**. If it doesn’t solve your problems, everything else is moot. It’s going to be software you love to use.
|
||||
|
|
@ -41,6 +39,7 @@ Here are the principles we use to guide our development. From [opensearch.org](
|
|||
If you're excited to jump in, we've marked a few issues that would be [really helpful](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
||||
|
||||
### Watch the forum, because there are a bunch of things we want to talk about
|
||||
|
||||
As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the [forums](https://discuss.opendistrocommunity.dev/). Please let us know your thoughts!
|
||||
|
||||
### Questions? Feedback?
|
||||
|
|
|
|||
Loading…
Reference in New Issue