improving the readme across all open-source repos (#24)

* im
proving the readme across all open-source repos

* adding code of conduct and readme

Author: sogipec

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Submit a change or a new feature
+
+First of all thank you for your interest in this repository!
+
+This is only the beginning of the Angle protocol and codebase, and anyone is welcome to improve it.
+
+To submit some code, please work in a fork, reach out to explain what you've done and open a Pull Request from your fork.
+
+Feel free to reach out in the [#developers channel](https://discord.gg/HcRB8QMeKU) of our Discord Server if you need a hand!

README.md

@@ -1,31 +1,61 @@
-# Angle Protocol
+# <img src="logo.svg" alt="Angle Core Module" height="40px"> Angle Core Module
 
-Core Module of the Angle Protocol.
+[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://docs.angle.money/angle-core-module/overview)
+[![Developers](https://img.shields.io/badge/developers-%F0%9F%93%84-pink)](https://developers.angle.money/core-module-contracts/protocol-and-architecture-overview)
 
 ## Documentation
 
+### To Start With
+
 Angle is a decentralized stablecoin protocol, designed to be both over-collateralized and capital-efficient. For more information about the protocol, you can refer to [Angle Documentation](https://docs.angle.money).
 
-The protocol is made of different modules, each with their own set of smart contracts. This repo contains the Core module smart contracts.
+The protocol is made of different modules, each with their own set of smart contracts. This repo contains the Core module smart contracts as well as the governance-related and staking contracts of the protocol.
 
 If you would like to know how the module works under the hood and how these smart contracts work together, you can also check [Angle Developers Doc](https://developers.angle.money/core-module-contracts/protocol-and-architecture-overview).
 
 Whitepaper for the module can be found [here](https://docs.angle.money/overview/whitepapers).
 
+### Further Information
+
+For a broader overview of the protocol and its different modules, you can also check [this overview page](https://developers.angle.money) of our developers documentation.
+
+Other Angle-related smart contracts can be found in the following repositories:
+
+- [Angle Borrowing module contracts](https://github.com/AngleProtocol/angle-borrow)
+- [Angle Strategies](https://github.com/AngleProtocol/angle-strategies)
+
+Otherwise, for more info about the protocol, check out [this portal](https://linktr.ee/angleprotocol) of resources.
+
 ## Module Architecture
 
 ![Angle Protocol Smart Contract Architecture](./AngleArchitectureSchema.png)
 
-## Audits
+## Remarks
 
-Angle Core module smart contracts have been audited by Sigma Prime and [Chainsecurity](https://chainsecurity.com/security-audit/angle-protocol/). The audit reports can be found in the `audits/` folder of this repo. Every contract of the protocol has been audited at least by one of the two auditors.
+### Strategies
 
-All Angle Protocol related audits can be found in [this page](https://docs.angle.money/resources/audits) of our docs.
+The Core module relies on yield strategies. While some templates of the strategy contracts used are present in this repo, these contracts are now all developed in the [Angle Strategies repo](https://github.com/AngleProtocol/angle-strategies). This is where you can get the up-to-date version of the contracts used on-chain.
+
+### Cross-module Contracts
+
+Some smart contracts of the protocol, beyond strategy contracts, are used across the different modules of Angle (like the `agToken` contract) and you'll sometimes see different versions across the different repositories of the protocol.
+
+Here are some cross-module contracts and the repos in which you should look for their correct and latest version:
 
-## Some Remarks on the Code
+- [`angle-core`](https://github.com/AngleProtocol/angle-core): All DAO-related contracts (`ANGLE`, `veANGLE`, gauges, surplus distribution, ...), `AngleRouter` contract
+- [`angle-borrow`](https://github.com/AngleProtocol/angle-borrow): `agToken` contract
+- [`angle-strategies`](https://github.com/AngleProtocol/angle-strategies): Yield strategies of the protocol
+
+### Error Messages
 
 Some smart contracts use error messages. These error messages are sometimes encoded in numbers rather than as custom errors like done most of the time. The conversion from numbers to error messages can be found in `errorMessages.json`.
 
+## Audits
+
+Angle Core module and governance smart contracts have been audited by Sigma Prime and [Chainsecurity](https://chainsecurity.com/security-audit/angle-protocol/). The audit reports can be found in the `audits/` folder of this repo. Contracts of the module have been audited at least by one of the two auditors.
+
+All Angle Protocol related audits can be found in [this page](https://docs.angle.money/resources/audits) of our docs.
+
 ## Bug Bounty
 
 At Angle, we consider the security of our systems a top priority. But even putting top priority status and maximum effort, there is still possibility that vulnerabilities exist.
@@ -50,13 +80,3 @@ All bug reports must include a Proof of Concept demonstrating how the vulnerabil
 ## Usage
 
 Note that this repo is not a repo on which the Angle Core Team develops. There is another repo, with all the tests and scripts, that is actively worked on.
-
-## Further Information
-
-For a broader overview of the protocol and its different modules, you can also check [this overview page](https://developers.angle.money) of our developers documentation.
-
-Other Angle-related smart contracts can be found in the following repositories:
-
-- [Angle Borrowing module contracts](https://github.com/AngleProtocol/angle-borrow)
-
-Otherwise, for more info about the protocol, check out [this portal](https://linktr.ee/angleprotocol) of resources.