Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme
Browse files Browse the repository at this point in the history
Signed-off-by: Karim TAAM <[email protected]>
matkt committed Nov 6, 2023
1 parent 3b5a065 commit 1d72695
Showing 3 changed files with 110 additions and 0 deletions.
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing to Hyperledger Besu verkle trie
## :tada: Thanks for taking the time to contribute! :tada:

Welcome to the Besu verkle trie repository! The following links are a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. Contributions come in the form of code submissions, writing documentation, raising issues, helping others in chat, and any other actions that help develop Besu verkle trie.

### Github/Discord/LF Accounts

Having the following accounts is necessary for contributing code/issues to Besu verkle trie.
* If you want to contribute code, you can make a [github account here](https://github.com).
* If you want to raise an issue, do so [in the issues tab](https://github.com/hyperledger/besu-verkle-trie/issues).
* To ask questions or chat with us, join our [Discord](https://discord.gg/hyperledger)
* To edit pages in our wiki, you'll need a [Linux Foundation (LF) account].

### Useful contributing links

* [I just have a quick question](https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question)
* [How to Contribute]
* [First contribution workflow](https://wiki.hyperledger.org/display/BESU/First+contribution?src=contextnavpagetreemode)
* [Did you find a bug?](https://wiki.hyperledger.org/display/BESU/Reporting+Bugs)
* [Issues](https://wiki.hyperledger.org/display/BESU/Issues)
* [DCO](https://wiki.hyperledger.org/display/BESU/DCO)
* [Suggesting Enhancements](https://wiki.hyperledger.org/display/BESU/Suggesting+Enhancements)
* [Pull Requests](https://wiki.hyperledger.org/display/BESU/Pull+Requests)
* [Code Reviews](https://wiki.hyperledger.org/display/BESU/Code+Reviews)


* [Security contributions](https://wiki.hyperledger.org/display/BESU/Security)

### Other important information

* [Roadmap](https://wiki.hyperledger.org/display/BESU/Roadmap)
* [Code of Conduct](https://wiki.hyperledger.org/display/BESU/Code+of+Conduct)
* [Governance](https://wiki.hyperledger.org/display/BESU/Governance)

[How to Contribute]: https://wiki.hyperledger.org/display/BESU/How+to+Contribute
[Linux Foundation (LF) account]: https://identity.linuxfoundation.org/
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# besu-verkle-trie


`besu-verkle-trie` is a Java library that implements the Java part of Verkle Trie for Ethereum.


## Table of Contents


- [Installation](#installation)

- [Building](#building)

- [Contribute](#contribute)

- [License](#license)


## Installation


`besu-verkle-trie` is available on [Hyperledger Artifactory](https://hyperledger.jfrog.io/ui/packages?name=besu-verkle-trie&type=packages).


To install `besu-verkle-trie`, you can use the build automation tool [Gradle](https://gradle.org/).


## Building


To build the project, use the `build` task:


```bash
gradle build
```

To format the code according to the project's style guide, use the spotlessApply task:

```bash
gradle spotlessApply
```

## Contribute

Contributions are welcome! Please see - [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## LICENSE



`besu-verkle-trie` is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
22 changes: 22 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Hyperledger Security Policy

## Reporting a Security Bug

If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to
hear from you. We will take all security bugs seriously and if confirmed upon investigation we will
patch it within a reasonable amount of time and release a public security bulletin discussing the
impact and credit the discoverer.

There are two email addresses where Hyperledger Besu accepts security bugs. The
first, [security "dash" besu at lists dot hyperledger dot org](mailto:[email protected])
is limited to a subset of Hyperledger Besu maintainers and Hyperledger staff. For highly sensitive
bugs this is a preferred address. The second email
address [security at hyperledger dot org](mailto:[email protected]) is limited to a subset of
maintainers and staff of all Hyperledger projects, and may be viewed by maintainers outside of
Hyperledger Besu. When sending information to either of these emails please be sure to include a
description of the flaw and any related information (e.g. reproduction steps, version, known active
use).

The process by which the Hyperledger Security Team handles security bugs is documented further in
our [Defect Response page](https://wiki.hyperledger.org/display/SEC/Defect+Response) on our
[wiki](https://wiki.hyperledger.org).

0 comments on commit 1d72695

Please sign in to comment.