Skip to content

docs: add Contributing section #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dahlinomine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Contributing section #488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ SPDX-License-Identifier: Apache-2.0

[![Coverage Status](https://coveralls.io/repos/github/hyperledger/fabric-x-committer/badge.svg?branch=main)](https://coveralls.io/github/hyperledger/fabric-x-committer?branch=main)

Fabric-X Committer is a high-performance validation and commitment engine for Hyperledger Fabric. It provides the core logic for verifying transaction signatures and ensuring state consistency through serial number (SN) double-spend prevention.

## Setup and Testing

See [setup](docs/setup.md) for details on prerequisites and quick start guide.
Expand All @@ -18,3 +20,6 @@ The lifecycle of a transaction consists of 3 main stages:
* **Validation**: It takes place at the committer and it checks whether:
* the signature is valid (not corrupt and it belongs to the endorsers)
* the tokens (inputs or **Serial Numbers/SN**) have not already spent in a previous transaction (using the order as defined by the orderer)

## Contributing
We welcome contributions to Fabric-X Committer! Please refer to the Hyperledger [Contribution Guide](https://github.com/hyperledger/fabric/blob/main/CONTRIBUTING.md) for details on coding standards, pull request processes, and signing your work with a Developer Certificate of Origin (DCO).