This is an automated email from the ASF dual-hosted git repository.
ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/main by this push:
new d0f738c Update and improvement in README (#2068)
d0f738c is described below
commit d0f738cf62fce03c546f72981016e8169e4d3f61
Author: nicolasalarconrapela <nicolasalarconrap...@gmail.com>
AuthorDate: Wed May 5 22:02:52 2021 +0200
Update and improvement in README (#2068)
- CONTRIBUTING.md
- Move to .github/
- Link to issues with 'Bug' label
- Improve formatting
- README.md
- Add Contributing section with link to website guide
- Add link to download page and improve wording
---
CONTRIBUTING.md => .github/CONTRIBUTING.md | 5 ++---
README.md | 13 +++++++++++--
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md
similarity index 76%
rename from CONTRIBUTING.md
rename to .github/CONTRIBUTING.md
index 693f910..2329f9c 100644
--- a/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -17,13 +17,13 @@ limitations under the License.
# Contributors Guide
- If you believe that you have found a bug, please search for an existing
[issue](https://github.com/apache/accumulo/issues) to see if it has already
been reported. If you would like to add a new feature to Accumulo, please send
an email with your idea to the [dev](mailto:d...@accumulo.apache.org) mail
list. If it's appropriate, then we will create an issue. For simple changes,
its ok to just submit a pull request without an issue.
+If you believe that you have found a
[bug](https://github.com/apache/accumulo/labels/bug), please search for an
existing [issue](https://github.com/apache/accumulo/issues) to see if it has
already been reported. If you would like to add a new feature to Accumulo,
please send an email with your idea to the
[dev](mailto:d...@accumulo.apache.org) mail list. If it's appropriate, then we
will create an issue. For simple changes, its ok to just submit a pull request
without an issue.
## Development
- See the [Developer's Guide](https://accumulo.apache.org/how-to-contribute/)
for information regarding common build commands, IDE setup and more.
- Ensure that your work targets the correct branch
-- Add / update unit and integration tests
+- Add/update unit and integration tests
## Patch Submission
@@ -35,4 +35,3 @@ limitations under the License.
- We welcome reviews from anyone. Any committer can approve and merge the
changes.
- Reviewers will likely have questions and comments. They may use terms such
as those in [RFC2119](https://tools.ietf.org/html/rfc2119).
-
diff --git a/README.md b/README.md
index 9537db9..ed1a335 100644
--- a/README.md
+++ b/README.md
@@ -22,8 +22,9 @@ limitations under the License.
[Apache Accumulo][accumulo] is a sorted, distributed key/value store that
provides robust,
scalable data storage and retrieval. With Apache Accumulo, users can store and
manage large
data sets across a cluster. Accumulo uses [Apache Hadoop]'s HDFS to store its
data and
-[Apache Zookeeper] for consensus. Check out the [Accumulo project
website][accumulo] for
-news and general information.
+[Apache Zookeeper] for consensus.
+
+Download the latest version of Apache Accumulo on the [project website][dl].
## Getting Started
@@ -44,6 +45,12 @@ waiting for the tests to run.
This command produces `assemble/target/accumulo-<version>-bin.tar.gz`
+## Contributing
+
+Contributions are welcome to all Apache Accumulo repositories.
+
+If you want to contribute, read [our guide on our website][contribute].
+
## Export Control
<details>
@@ -100,3 +107,5 @@ more details on bouncycastle's cryptography features.
[tl]: https://github.com/apache/accumulo/actions
[java-export]:
https://www.oracle.com/us/products/export/export-regulations-345813.html
[bouncy-site]: https://bouncycastle.org
+[dl]: https://accumulo.apache.org/downloads
+[contribute]: https://accumulo.apache.org/how-to-contribute
