docs: add contributor_guide and libraries
This commit is contained in:
jinhojang6
Jinho Jang
parent
f8f0d110c4
commit
1e35fe9c46
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Contributor Guide
|
||||
sidebar_label: Contributor Guide
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
## How to help with funding
|
||||
|
||||
We have a donation box set up at address `0xDeb4A0e8d9a8dB30a9f53AF2dCc9Eb27060c6557`, as well as a [Gitcoin Grant page](https://gitcoin.co/grants/137/nimbus-2/).
|
||||
|
||||
We use funds from donations to:
|
||||
|
||||
- fund bounties
|
||||
- fund audits of our production code
|
||||
- fund hardware on which to build Nimbus for you, from Raspberry Pis to feature phones
|
||||
|
||||
If you'd like to donate a conditional amount, i.e. one that depends on a certain milestone or deadline, please [get in touch](mailto:jacek@status.im).
|
||||
|
||||
## How to get involved with Nimbus' development
|
||||
|
||||
- look around [the repo](https://github.com/status-im/nimbus-eth2), especially the [open issues](https://github.com/status-im/nimbus-eth2/issues)
|
||||
- check out some [open bounties](https://gitcoin.co/explorer?keywords=nimbus&order_by=-web3_created)
|
||||
- learn about the source code by [dissecting](https://github.com/status-im/nimbus-eth2/tree/master/tests)
|
||||
|
||||
To configure your setup for development:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/status-im/nimbus-eth2
|
||||
cd nimbus-eth2
|
||||
make update
|
||||
```
|
||||
|
||||
[Build](/docs/eth2.html) and start hacking!
|
||||
|
||||
## Thought experiments
|
||||
|
||||
<blockquote className="twitter-tweet" data-theme="dark"><p lang="en" dir="ltr">Still hoping to just have my <a href="https://twitter.com/ethstatus?ref_src=twsrc%5Etfw">@ethstatus</a> desktop wallet be my bn, and have my mobile device be my <a href="https://twitter.com/ethnimbus?ref_src=twsrc%5Etfw">@ethnimbus</a> vc 🤷🏽♀️😅. And then a nice little Rocketpool Staas run by <a href="https://twitter.com/search?q=%24SNT&src=ctag&ref_src=twsrc%5Etfw">$SNT</a>... And anonymous staking in "dark pools" build on application layer, fees paid to client/network nodes. 👌🏽😻.</p>— chloethedev.eth ⟠ δούλος 🏳️⚧️ (@Chloethedev) <a href="https://twitter.com/Chloethedev/status/1320710462032515072?ref_src=twsrc%5Etfw">October 26, 2020</a></blockquote>
|
||||
|
||||
If you have research ideas you'd like to throw at us, exotic hardware you'd like to test on, or anything else revolutionary cooking up in your mind let us know. We'll gladly experiment!
|
||||
|
||||
## Guidelines
|
||||
|
||||
Whatever you might expect to see in other projects applies here:
|
||||
|
||||
- Be nice to others
|
||||
- When evaluating PRs, focus exclusively on the quality of the code
|
||||
- If submitting code, make sure it's tested. All code MUST come with tests. To speed up the review, ping a [team member](/docs/team).
|
||||
- If submitting typo fixes or documentation changes, speed up the review process by pinging a team member. [Jacek](https://github.com/arnetheduck) or [Sacha](https://github.com/unixpi) will usually review those very quickly. The same applies if submitting a tutorial for inclusion on the [official blog](https://our.status.im/tag/nimbus).
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
title: Frequently asked questions
|
||||
hide_table_of_contents: true
|
||||
sidebar_label: FAQ
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
import { AccordionItem } from '@site/src/components/mdx'
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: Explore our libraries
|
||||
sidebar_label: Software Libraries
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
In addition to our [execution layer](https://github.com/status-im/nimbus-eth1) and [consensus layer](https://github.com/status-im/nimbus-eth2) clients we have developed several high-quality libraries (the product of our ethereum work in Nim). These include:
|
||||
|
||||
- Nim libp2p: https://github.com/status-im/nim-libp2p
|
||||
|
||||
- Nim BLS Curve: https://github.com/status-im/nim-blscurve
|
||||
|
||||
- Nim Waku - Waku is a fork of the original Whisper protocol that enables better usability for resource restricted devices: https://github.com/status-im/nim-waku
|
||||
|
||||
- Nim QUIC - QUIC is being adopted as the underlying protocol for HTTP/3 and has the potential to give us censorship resistance due to its resistance to deep packet inspection: https://github.com/status-im/nim-quic
|
||||
|
||||
- Cryptographic functions: https://github.com/cheatfate/nimcrypto
|
||||
|
||||
- Nim Chronicles - detailed logging for Nim: https://github.com/status-im/nim-chronicles
|
||||
|
||||
- Nim Chronos - async Nim: https://github.com/status-im/nim-chronos
|
||||
|
||||
- Nim Web3 - https://github.com/status-im/nim-web3
|
||||
|
||||
- Ethereum Smart Contracts in Nim: https://github.com/status-im/nim-eth-contracts
|
||||
|
||||
- Nim JSON-RPC - a library for routing JSON 2.0 format remote procedure calls over different transports: https://github.com/status-im/nim-json-rpc
|
||||
|
||||
- Nim Stint - a stack based arbitrary precision library: https://github.com/status-im/nim-stint
|
||||
|
||||
- Nim Libbacktrace: https://github.com/status-im/nim-libbacktrace
|
||||
|
||||
- Nim EthHash - proof of work algorithm from Ethereum 1.0 reimplemented in Nim: https://github.com/status-im/nim-ethash
|
||||
|
||||
- Nim Eth - Ethereum-related utilities written in Nim: https://github.com/status-im/nim-eth
|
||||
|
||||
- Documentation Generator - language agnostic (but Nim-preconfigured) generator for beautiful detailed documentation suites for sets of libraries: https://github.com/status-im/nimbus-docs-suite
|
||||
|
||||
- Nim presto - an efficient library for REST API implementation: https://github.com/status-im/nim-presto
|
||||
|
||||
|
||||
We hope you take the time to check them out :)
|
||||
Loading…
Reference in New Issue