From 649cac5c6fb7fc9b532bced9bc8a43d38dc5141d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Artur=20Micha=C5=82ek?=
 <52135326+cptartur@users.noreply.github.com>
Date: Thu, 9 May 2024 18:03:50 +0200
Subject: [PATCH] Update readme (#2)

* Extend neurons readme

* Add contributing guidelines

* Extend readme

* Add newline
---
 CONTRIBUTING.md   | 22 ++++++++++++++++++++++
 README.md         | 25 ++++++++++++++++++++++++-
 neurons/README.md | 22 ++++++++++++++++++++++
 3 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2be6bd0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contribution Guidelines
+
+Thank you for taking time to improve NQG implementation.
+To make the contribution process convenient for both you and us, please follow the outlined guildines.
+
+## Opening an Issue
+
+[//]: # (TODO add link to issues)
+
+Before starting any work on a feature or a bugfix, please [open an issue]().
+Opening an issue gives an opportunity to discuss if a feature is relevant to the project and if the proposed bugfix is a
+preferred solution which saves time in the Pull Request review phase.
+
+## Opening a Pull Request
+
+After you have implemented your changes, feel free to open a Pull Request.
+We encourage you to fill out the necessary details in the pull request description.
+
+Make sure that your changes are:
+
+1. Well documented
+2. Thoroughly tested with relevant automatic tests
diff --git a/README.md b/README.md
index 2e00733..57127c9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# stellar-community-fund-contracts
\ No newline at end of file
+# Neural Quorum Governance Contracts
+
+> ⚠️ Code in this repository has not been audited and is under development.
+[Neural Quorum Governance](https://stellarcommunityfund.gitbook.io/module-library/power-attribution/neural-governance)
+> is a governance framework implemented on the Stellar blockchain.
+> This repository contains smart contract used to conduct voting on-chain and rust modules we are using to calculate
+> neurons voting powers.
+
+## `/neurons`
+
+Contains source code of neurons. [See neurons docs for more details](neurons/README.md).
+
+## `/contract`
+
+Contains the source code of the governance contract. [See contract docs for more details](contracts/offchain/README.md).
+
+## Reporting Bugs and Issues
+
+Found a bug or an issue and want to report it? Please [open an issue](https://github.com/stellar/stellar-community-fund-contracts/issues).
+
+## Contributing
+
+This repository is under active development. Read the [contributing guidelines](./CONTRIBUTING.md) for more
+information.
diff --git a/neurons/README.md b/neurons/README.md
index 7fedf8b..ab9a395 100644
--- a/neurons/README.md
+++ b/neurons/README.md
@@ -35,3 +35,25 @@ Assigns voting power based on rounds voter previously participated in.
 
 Assigns voting power based on trust assigned to voter by other voters.
 It uses min-max normalized PageRank algorithm to compute the score.
+
+## Development
+
+### Running Tests
+
+```shell
+cargo test
+```
+
+### Running Lint
+
+```shell
+cargo lint
+```
+
+This is an alias to `cargo clippy` with special config. See `.cargo/config.toml` for more details.
+
+### Formatting
+
+```shell
+cargo fmt
+```