Merge branch 'main' into erc1155

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# 🫡 Contributing to 🐍 snekmate
+
+🙏 Thank you so much for your help in improving the project and pushing 🐍Vyper's long-term success! Many folks will be grateful to you. We are so glad to have you!
+
+There are many ways to get involved at every level. It doesn't matter if you have just started with 🐍Vyper or are the most experienced expert, we can use your help.
+
+**No contribution is too small and all contributions are highly appreciated.**
+
+We particularly welcome support in the following areas:
+
+- Reporting issues. For security issues, see our [Security Policy](./SECURITY.md).
+- Fixing and responding to existing issues.
+- Proposing changes and/or new features.
+- Implementing changes and/or new features.
+- Improving documentation and fixing typos.
+
+> If you are writing a new feature and/or a breaking change, please ensure that you include appropriate test cases.
+
+## 🛠 Creating a Pull Request (PR)
+
+As a contributor, you are expected to fork the `main` branch of this repository, work on your own fork, and then submit pull requests. The pull requests are reviewed and eventually merged into the main repository. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo) for how this works.
+
+## 🌀 Dependencies
+
+You will need the following dependencies:
+
+- [Git](https://git-scm.com)
+- [Node.js](https://nodejs.org)
+- [Yarn](https://classic.yarnpkg.com)
+- [🐍Vyper](https://github.com/vyperlang/vyper)
+- [Foundry](https://github.com/foundry-rs/foundry)
+
+## ⚙️ Installation
+
+It is recommended to install [Yarn](https://classic.yarnpkg.com) through the `npm` package manager, which comes bundled with [Node.js](https://nodejs.org) when you install it on your system. It is recommended to use a Node.js version `>= 16.0.0`.
+
+Once you have `npm` installed, you can run the following both to install and upgrade Yarn:
+
+```bash
+npm install --global yarn
+```
+
+After having installed Yarn, simply run:
+
+```bash
+yarn install
+```
+
+This repository also includes the [Foundry](https://github.com/foundry-rs/foundry) toolkit. You can simply run `forge install` to install all the submodule dependencies that are in this repository. If you need help getting started with Foundry, we recommend reading the [📖 Foundry Book](https://book.getfoundry.sh).

README.md

@@ -44,6 +44,10 @@ This repository is inspired by or directly modified from many sources, primarily
 - [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts)
 - [Solmate](https://github.com/transmissions11/solmate)
 
+## 🫡 Contributing
+
+🐍 snekmate only exists thanks to its [contributors](https://github.com/pcaversaccio/snekmate/graphs/contributors). There are many ways to get involved and contribute to our high-quality and secure smart contracts. Check out our [Contribution Guidelines](./CONTRIBUTING.md)!
+
 ## 💢 Disclaimer
 
 <img src=https://user-images.githubusercontent.com/25297591/167394075-1813e258-3b03-4bc8-9305-69126a07d57e.png width="1050"/>