-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
423ae8e
commit 18517bd
Showing
3 changed files
with
69 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
scarb 2.6.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters