-
Notifications
You must be signed in to change notification settings - Fork 29
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
Showing
14 changed files
with
208 additions
and
7 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,16 @@ | ||
{ | ||
"projectName": "starknet-phone", | ||
"projectOwner": "drspacemn", | ||
"repoType": "github", | ||
"repoHost": "https://github.com", | ||
"files": [ | ||
"README.md", | ||
"CONTRIBUTING.md" | ||
], | ||
"imageSize": 100, | ||
"commit": true, | ||
"commitConvention": "gitmoji", | ||
"contributors": [], | ||
"contributorsPerLine": 7, | ||
"linkToUsage": false | ||
} |
Validating CODEOWNERS rules …
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 @@ | ||
* @drspacemn @trbutler4 |
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,11 @@ | ||
--- | ||
name: Feature request | ||
about: suggest new feature | ||
title: "[feat] " | ||
labels: "feature" | ||
assignees: "" | ||
--- | ||
|
||
<!-- feature description --> | ||
|
||
#### References |
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,13 @@ | ||
--- | ||
name: Bug report | ||
about: create bug report | ||
title: "[bug] " | ||
labels: "bug" | ||
assignees: "" | ||
--- | ||
|
||
**ver:** | ||
|
||
<!-- reproducible report(current vs expected behavior) --> | ||
|
||
**How to reproduce:** |
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,7 @@ | ||
--- | ||
name: Codebase improvement | ||
about: docs, ci, tooling, other | ||
title: "[dev] " | ||
labels: "dev" | ||
assignees: "" | ||
--- |
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,8 @@ | ||
<!-- enter the gh issue after hash --> | ||
|
||
- [ ] issue # | ||
- [ ] follows contribution [guide](https://github.com/keep-starknet-strange/starknet-phone/blob/main/CONTRIBUTING.md) | ||
- [ ] code change includes tests | ||
- [ ] breaking change | ||
|
||
<!-- PR description below --> |
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,4 @@ | ||
all | ||
# lame rules | ||
exclude_rule 'MD002' | ||
exclude_rule 'MD041' |
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,10 @@ | ||
all | ||
# allow inline HTML for README fmt | ||
exclude_rule 'MD033' | ||
# badges trigger rule | ||
exclude_rule 'MD034' | ||
# README img serves as 'First Header' | ||
exclude_rule 'MD002' | ||
exclude_rule 'MD041' | ||
# TODO: disable/enable not working for all-contribs | ||
exclude_rule 'MD013' |
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,30 @@ | ||
name: book | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- book/** | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
book: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: Swatinem/rust-cache@v2 | ||
- name: Build | ||
run: | | ||
cargo install mdbook | ||
mdbook build book | ||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./docs/book |
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,19 @@ | ||
name: check | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
permissions: read-all | ||
|
||
jobs: | ||
markdown: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- run: | | ||
sudo gem install mdl | ||
mdl -s .github/linter/readme_style.rb README.md | ||
mdl -s .github/linter/base_style.rb docs .github CONTRIBUTING.md |
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,5 @@ | ||
# Sys files | ||
**/.DS_Store | ||
|
||
# mdBook | ||
docs/book/ |
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 Starknet Phone 🛠️ | ||
|
||
<!-- markdownlint-disable MD051 --> | ||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) | ||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
<!-- markdownlint-enable MD051 --> | ||
|
||
Welcome, contributing to `starknet-phone` 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 Review | ||
|
||
### Issue | ||
|
||
Project tracking is done via GitHub [issues](https://github.com/keep-starknet-strange/starknet-phone/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 `starknet-phone` 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 | ||
``` | ||
|
||
### 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/) | ||
- [blockstream-sn TG](https://t.me/+N7UqCg2hxA4wNTZh) | ||
- [Syncing a Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) | ||
- [Submitting data blobs to Celestia](https://docs.celestia.org/developers/submit-data) | ||
|
||
## | ||
|
||
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,32 @@ | ||
# Starknet Phone | ||
|
||
|
||
## License | ||
## License | ||
|
||
This project is licensed under the MIT license. | ||
|
||
See [LICENSE](./LICENSE) for more information. | ||
|
||
|
||
## Resources | ||
## Resources | ||
|
||
[building graphene os](https://grapheneos.org/build) | ||
|
||
### Ethereum Phone | ||
### Ethereum Phone | ||
|
||
[Ethereum Phone platform manifest](https://github.com/EthereumPhone/platform_manifest) | ||
|
||
[wallet sdk](https://github.com/EthereumPhone/WalletSDK) | ||
|
||
[light node app](https://github.com/EthereumPhone/lightnodeapp) | ||
|
||
## Contributors ✨ | ||
|
||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
<!-- prettier-ignore-start --> | ||
<!-- markdownlint-disable --> | ||
<!-- markdownlint-restore --> | ||
<!-- prettier-ignore-end --> | ||
<!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
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 |
---|---|---|
@@ -1,8 +1,8 @@ | ||
|
||
# Introduction to CairoOS | ||
# Introduction to Starknet Phone | ||
|
||
WIP | ||
|
||
## GrapheneOS | ||
## GrapheneOS | ||
|
||
[GrapheneOS Docs](https://grapheneos.org/build#build-dependencies) |