Skip to content

Commit ed53549

Browse files
committed
HBASE-27513 Modify README.txt to mention how to contribue (#4913)
Signed-off-by: Bryan Beaudreault <[email protected]> Signed-off-by: Guanghao Zhang <[email protected]> Signed-off-by: Xiaolin Ha <[email protected]> Signed-off-by: Zheng Hu <[email protected]> (cherry picked from commit 4d70f94)
1 parent c208456 commit ed53549

File tree

2 files changed

+54
-34
lines changed

2 files changed

+54
-34
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
![hbase-logo](https://raw.githubusercontent.com/apache/hbase/master/src/site/resources/images/hbase_logo_with_orca_large.png)
21+
22+
[Apache HBase](https://hbase.apache.org) is an open-source, distributed, versioned, column-oriented store modeled after Google' [Bigtable](https://research.google.com/archive/bigtable.html): A Distributed Storage System for Structured Data by Chang et al. Just as Bigtable leverages the distributed data storage provided by the Google File System, HBase provides Bigtable-like capabilities on top of [Apache Hadoop](https://hadoop.apache.org/).
23+
24+
# Getting Start
25+
To get started using HBase, the full documentation for this release can be found under the doc/ directory that accompanies this README. Using a browser, open the docs/index.html to view the project home page (or browse https://hbase.apache.org). The hbase '[book](https://hbase.apache.org/book.html)' has a 'quick start' section and is where you should being your exploration of the hbase project.
26+
27+
The latest HBase can be downloaded from the [download page](https://hbase.apache.org/downloads.html).
28+
29+
We use mailing lists to send notice and discuss. The mailing lists and archives are listed [here](http://hbase.apache.org/mail-lists.html)
30+
31+
# How to Contribute
32+
The source code can be found at https://hbase.apache.org/source-repository.html
33+
34+
The HBase issue tracker is at https://hbase.apache.org/issue-tracking.html
35+
36+
Notice that, the public registration for https://issues.apache.org/ has been disabled due to spam. If you want to contribute to HBase, please send an email to [[email protected]](mailto:[email protected]) in the follow format so the HBase PMC members can acquire a jira account for you:
37+
38+
```
39+
Subject: Request for Jira account
40+
41+
Contents of the mail(should be in English):
42+
Preferred Jira Id: [a-z0-9]+
43+
Full Name:
44+
E-Mail Address:
45+
46+
Reason: Jira Id you wish to contribute to, or details around the bug/feature you wish to report or work on.
47+
```
48+
49+
> **_NOTE:_** we need to process the requests manually so it may take sometime, for example, up to a week, for us to respond to your request.
50+
51+
# About
52+
Apache HBase is made available under the [Apache License, version 2.0](https://hbase.apache.org/license.html)
53+
54+
The HBase distribution includes cryptographic software. See the export control notice [here](https://hbase.apache.org/export_control.html).

README.txt

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)