Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
conr2d committed Nov 17, 2024
1 parent 2f9a43e commit 857a096
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 3 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: "CLA Assistant"
on:
issue_comment:
types: [created]
pull_request_target:
types: [opened,closed,synchronize]

# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
permissions:
actions: write
contents: write # this can be 'read' if the signatures are in remote repository
pull-requests: write
statuses: write

jobs:
CLAAssistant:
runs-on: ubuntu-latest
steps:
- name: "CLA Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
uses: contributor-assistant/github-action@v2.6.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# the below token should have repo scope and must be manually added by you in the repository's secret
# This token is required only if you have configured to store the signatures in a remote repository/organization
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
with:
path-to-signatures: 'signatures/version1/cla.json'
path-to-document: 'https://github.com/cla-assistant/github-action/blob/master/SAPCLA.md' # e.g. a CLA or a DCO document
# branch should not be protected
branch: 'main'
allowlist: user1,bot*

# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
remote-organization-name: noirhq
remote-repository-name: clas
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
#signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
#custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
#use-dco-flag: true - If you are using DCO instead of CLA
23 changes: 23 additions & 0 deletions ACKNOWLEDGEMENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Acknowledgements

This is a list of notable sources that enable achieving cross-protocol compatibility in Noir.

## Polkadot

- [Polkadot SDK](https://github.com/paritytech/polkadot-sdk): Core engine and Polkadot

## Ethereum

- [Frontier](https://github.com/polkadot-evm/frontier): Ethereum (EVM) in Polkadot SDK
- [Moonbeam](https://github.com/moonbeam-foundation/moonbeam): Custom EVM precompiles (ERC-20)
- [Darwinia](https://github.com/darwinia-network/darwinia): Custom EVM precompiles (Generic state)

## Solana

- [Solana](https://github.com/solana-labs/solana): Solana (BPF)

## Cosmos

- [Cosmos SDK](https://github.com/cosmos/cosmos-sdk): Cosmos
- [CosmWasm](https://github.com/CosmWasm/cosmwasm): Cosmos smart contract (WASM)
- [Composable](https://github.com/ComposableFi/composable): CosmWasm in Polkadot SDK
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing

Thank you for considering making contributions to the Noir project!

## Overview

Individuals making significant and valuable contributions are given commit access to the project. Contributions are done via pull requests and need to be approved by the maintainers.

## Rules

Here are some basic rules for all contributors (including the maintainers):

- **No `--force` pushes** or modifying the main branch history in any way. If you need to rebase, make sure to do it in your own repository. Do not rewrite the history after the code has been shared (e.g., through a Pull Request).
- **Non-main branches**, prefixed with a short name identifier (e.g., `conr2d/my-feature`), must be used for ongoing work.
- **All modifications** must be made in a **pull request** to solicit feedback from other contributors.
- A pull request **must not be merged until CI** has completed successfully.
- A pull request must pass tests with `cargo clippy && cargo fmt && cargo test`.

## Contributor License Agreement

All contributors must sign the Contributor License Agreement (CLA) before any contributions can be accepted. The signing process is automated via CLA Assistant, allowing you to agree through comments while submitting your PR.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,19 @@

[![GitHub License](https://img.shields.io/badge/license-GPL3%2FApache2-blue)](#LICENSE) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/noirhq/noir/ci.yml?event=push)](https://github.com/noirhq/noir)

Implementation of Noir, a metaprotocol for connecting heterogeneous distributed
systems.
> Network of Interplanetary Replicated state machines
Blockchain SDK designed for building an interoperable protocol to connect heterogeneous distributed systems

## License

- Noir Primitives (`np-*`) are licensed under [Apache-2.0](./LICENSE-APACHE2).
- All others are licensed under [GPL-3.0](./LICENSE).
- All others are licensed under [GPL-3.0](./LICENSE-GPL3).

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Acknowledgements

See [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md)

0 comments on commit 857a096

Please sign in to comment.