Skip to content

Commit

Permalink
👥 Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cairoeth committed Jan 9, 2024
1 parent d77763a commit 4197fa3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# 🫡 Contributing

🙏 Thank you so much for your interest in the project! There are many ways to get involved at every level.

**No contribution is too small and all contributions are highly appreciated.**

We particularly welcome support in the following areas:

- [Reporting issues](https://github.com/cairoeth/rustmate/issues/new).
- Fixing and responding to [existing issues](https://github.com/cairoeth/rustmate/issues).
- Proposing changes and/or [new features](https://github.com/cairoeth/rustmate/issues). We are mainly working on gas optimizations and implementation/ERC support.
- Implementing changes and/or new features.
- Improving documentation and fixing typos.

## 🙋‍♀️ Opening an Issue

If you encounter a bug or want to suggest a feature, you are welcome to [open an issue](https://github.com/cairoeth/rustmate/issues/new). Before opening an issue, please review the existing open and closed issues.

When you propose a new feature, you should provide as much detail as possible, especially on the use cases that motivate it. Features are prioritised by their potential impact on the ecosystem, so we value information that shows the impact could be high.

## 🛠 Submitting 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.

## 🤝 How to get started

Follow [these steps in the README](https://github.com/cairoeth/rustmate#-how-to-replicate) to get started locally.

0 comments on commit 4197fa3

Please sign in to comment.