diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..3db3e967 --- /dev/null +++ b/.all-contributorsrc @@ -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 +} diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..5b030015 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @drspacemn @trbutler4 diff --git a/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md new file mode 100644 index 00000000..ff340577 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md @@ -0,0 +1,11 @@ +--- +name: Feature request +about: suggest new feature +title: "[feat] " +labels: "feature" +assignees: "" +--- + + + +#### References diff --git a/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md b/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md new file mode 100644 index 00000000..57a92f1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md @@ -0,0 +1,13 @@ +--- +name: Bug report +about: create bug report +title: "[bug] " +labels: "bug" +assignees: "" +--- + +**ver:** + + + +**How to reproduce:** diff --git a/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md b/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md new file mode 100644 index 00000000..0132b950 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md @@ -0,0 +1,7 @@ +--- +name: Codebase improvement +about: docs, ci, tooling, other +title: "[dev] " +labels: "dev" +assignees: "" +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..484a7cc0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ + + +- [ ] issue # +- [ ] follows contribution [guide](https://github.com/keep-starknet-strange/starknet-phone/blob/main/CONTRIBUTING.md) +- [ ] code change includes tests +- [ ] breaking change + + diff --git a/.github/linter/base_style.rb b/.github/linter/base_style.rb new file mode 100644 index 00000000..8d981050 --- /dev/null +++ b/.github/linter/base_style.rb @@ -0,0 +1,4 @@ +all +# lame rules +exclude_rule 'MD002' +exclude_rule 'MD041' diff --git a/.github/linter/readme_style.rb b/.github/linter/readme_style.rb new file mode 100644 index 00000000..9b6cfc97 --- /dev/null +++ b/.github/linter/readme_style.rb @@ -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' diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 00000000..c057ec6f --- /dev/null +++ b/.github/workflows/book.yml @@ -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 diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 00000000..23b3b291 --- /dev/null +++ b/.github/workflows/check.yml @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..c6c8aba7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Sys files +**/.DS_Store + +# mdBook +docs/book/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cab1d4c0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +## 🛠️ Contributing to Starknet Phone 🛠️ + + + +[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) + + + +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! diff --git a/README.md b/README.md index 206ffe3c..363bd635 100644 --- a/README.md +++ b/README.md @@ -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)): + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/docs/src/intro.md b/docs/src/intro.md index ae89afb4..96b3c255 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -1,8 +1,8 @@ -# Introduction to CairoOS +# Introduction to Starknet Phone WIP -## GrapheneOS +## GrapheneOS [GrapheneOS Docs](https://grapheneos.org/build#build-dependencies)