From 18517bd57250ab6b1ea873137ab3a39bd6bcb8c3 Mon Sep 17 00:00:00 2001 From: "Abdel @ StarkWare" Date: Wed, 31 Jul 2024 09:29:04 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=9A=20fix=20ci?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .tool-versions | 1 + CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 6 ++--- 3 files changed, 69 insertions(+), 3 deletions(-) create mode 100644 .tool-versions create mode 100644 CONTRIBUTING.md diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 00000000..f239fe23 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +scarb 2.6.3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0cfa8591 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +## 🛠️ Contributing to raito 🛠️ + +Welcome, contributing to `raito` is easy! + +1. Submit or comment your intent on an issue +1. We will try to respond quickly +1. Fork this repo +1. Submit your PR against `main` +1. Address PR Reviews + +### Issue + +Project tracking is done via GitHub [issues](https://github.com/keep-starknet-strange/raito/issues) +First look at open issues to see if your request is already submitted. +If it is comment on the issue requesting assignment, if not open an issue. + +We use 3 issue labels for development: + +- `feat` -> suggest new feature +- `bug` -> create a reproducible bug report +- `dev` -> non-functional repository changes + +These labels are used as prefixes as follows for `issue`, `branch name`, `pr title`: + +- `[feat]` -> `feat/{issue #}-{issue name}` -> `feat:` +- `[bug]` -> `bug/{issue #}-{issue name}` -> `bug:` +- `[dev]` -> `dev/{issue #}-{issue name}` -> `dev:` + +#### TODO + +If your PR includes a `TODO` comment please open an issue and comment the relevant +code with `TODO(#ISSUE_NUM):`. + +### Submit PR + +Ensure your code is well formatted, well tested and well documented. A core contributor +will review your work. Address changes, ensure ci passes, +and voilà you're a `raito` contributor. + +Markdown [linter](https://github.com/markdownlint/markdownlint?tab=readme-ov-file#markdown-lint-tool): + +```bash +mdl -s .github/linter/readme_style.rb README.md +``` + +Scarb linter: + +```bash +scarb fmt +``` + +### Additional Resources + +- [Cairo Book](https://book.cairo-lang.org/) +- [Starknet Book](https://book.starknet.io/) +- [Starknet Foundry Book](https://foundry-rs.github.io/starknet-foundry/) +- [Starknet By Example](https://starknet-by-example.voyager.online/) +- [Starkli Book](https://book.starkli.rs/) +- [Bitcoin Wiki](https://en.bitcoin.it/wiki/Script) +- [Golang Bitcoin Implementation](https://github.com/btcsuite/btcd) +- [Syncing a Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) + +## + +Thank you for your contribution! diff --git a/README.md b/README.md index 1fbf6b8d..95639419 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ GitHub Workflow Status Bitcoin Cairo - +Exploration Team ## About @@ -27,9 +27,9 @@ Raito is a reference to Light Yagami (夜神月, Yagami Raito) from the manga/an Why ? - Raito in Japanese means "Light", which in turns can refer to Lightning ⚡ (and hence both a reference to speed of verification of the Bitcoin blockchain using a ZKP and a reference to the Lightning Network) -- Raito can work in tandem with [Shinigami](https://github.com/keep-starknet-strange/shinigami) that enables verification of Bitcoin Script programs. Raito = Consensus and Shinigami = Execution. +- Raito can work in tandem with [Raito](https://github.com/keep-starknet-strange/raito) that enables verification of Bitcoin Script programs. Raito = Consensus and Raito = Execution. -![Raito and Shinigami](./docs/img/memes/raito_shinigami_fusion.jpg) +![Raito and Raito](./docs/img/memes/raito_raito_fusion.jpg) ### Running