Merge pull request #43 from bandohq/chore/readme

CHORE - Add README V1 and contrib docs.

CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq.
+
+[homepage]: https://www.contributor-covenant.org
+

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+
+# Contributing to Bando
+
+🎉 Thank you for your interest in contributing to Bando! 🎉
+
+We welcome contributions from everyone. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you encounter a bug or issue with the project, please follow these steps:
+
+1. Check the [existing issues](https://github.com/bandohq/evm-fulfillment-protocol/issues) to see if the issue has already been reported.
+2. If it hasn't, [create a new issue](https://github.com/bandohq/evm-fulfillment-protocol/issues/new) with a descriptive title and detailed description of the problem, including steps to reproduce if possible.
+
+### Suggesting Enhancements
+
+We welcome suggestions for how we can improve Bando. If you have an idea for an enhancement, follow these steps:
+
+1. Check the [existing issues](https://github.com/bandohq/evm-fulfillment-protocol/issues) to see if the enhancement has already been suggested.
+2. If it hasn't, [create a new issue](https://github.com/bandohq/evm-fulfillment-protocol/issues/new) with a clear title and description of your enhancement idea.
+
+### Pull Requests
+
+We actively welcome your pull requests! To contribute code to Bando, follow these steps:
+
+1. Fork the repository and create your own branch off the `main` branch.
+2. Make your changes and ensure the code is well-documented and tested.
+3. Open a pull request (PR) to the `main` branch of the original repository, describing the changes you've made.
+
+### Code Style
+
+- Follow the coding style and conventions used throughout the project.
+- Ensure any new code adheres to existing patterns and practices.
+- Write clear commit messages and PR descriptions.
+
+### Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [maintainer's email].
+
+### License
+
+By contributing to Bando, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file of the project.

README.md

@@ -1,34 +1,48 @@
-# toppi-dapp
-Toppi's dApp.
+# Bando EVM Smart Contracts
 
+The Bando Fulfillment Protocol EVM smart contracts suite suite.
 
-## Starting Up 
+[![Run Tests and Coverage](https://github.com/bandohq/evm-fulfillment-protocol/actions/workflows/hardhat-test.yaml/badge.svg)](https://github.com/bandohq/evm-fulfillment-protocol/actions/workflows/hardhat-test.yaml)
 
-Utiliza 
-- Truffle 
-- ganache-cli
+## Overview 
+For a more detail view of the protocol architecture, security considerations, and product as a whole, please refer to the [Official Docs](https://docs.bando.cool).
 
+The project is a hybrid of hardhat and forge. 
+We run integration tests with hardhat and deploy and run other tests with forge.
 
-1. Install Truffle
-```
-npm install -g truffle
-```
-2. Instala los paquetes pendientes
+## Pre-requisites
+
+- Node.js v16.x
+- Foundry
+- Hardhat
+- Solidity 0.8.20
+
+## Installation
+
+Install dependencies with forge
+```shell
+forge install
 ```
-npm install
+Install hardhat project dependencies
+```shell
+yarn install
 ```
-3. Instala Ganache
+
+## Compile Contracts
+
+Compile contracts with forge
+```shell
+forge build [--sizes]
 ```
-npm install -g ganache-cli
+
+## Run Tests
+
+Run tests with hardhat
+```shell
+yarn hardhat test
 ```
-4. Después de que todo este instalado 
-   5. Levanta ganache
-   ```
-   npm install -g ganache-cli
-   ```
-   6. Prendele Trufle
-    ``` 
-        truffle test
-        truffle migrate
-        npx truffle test 
-    ```
+
+Run coverage report with hardhat
+```shell
+yarn hardhat coverage
+```