Skip to content

Commit 4070ac6

Browse files
authored
Merge pull request #14 from trbutler4/contrib
add contributing instructions
2 parents 81575d9 + f55600a commit 4070ac6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## 🛠️ Contributing to Zed Cairo 🛠️
2+
3+
4+
Welcome, contributing to `zed-cairo` is easy!
5+
6+
1. Submit or comment your intent on an issue
7+
1. We will try to respond quickly
8+
1. Fork this repo
9+
1. Submit your PR against `main`
10+
1. Address PR Review
11+
12+
### Issue
13+
14+
Project tracking is done via GitHub [issues](https://github.com/trbutler4/zed-cairo).
15+
First look at open issues to see if your request is already submitted.
16+
If it is comment on the issue requesting assignment, if not open an issue.
17+
18+
### Submit PR
19+
20+
Ensure your code is well formatted, well tested and well documented. A core contributor
21+
will review your work. Address changes, ensure ci passes,
22+
and voilà you're a `zed-cairo` contributor.
23+
24+
### Additional Resources
25+
26+
- [Zed Editor docs](https://zed.dev/docs/)
27+
- [Cairo Book](https://book.cairo-lang.org/)
28+
- [Cairo tree-sitter implementation](https://github.com/starkware-libs/tree-sitter-cairo)
29+
30+
Thank you for your contribution!

0 commit comments

Comments
 (0)