diff --git a/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md index d834b31..ff481a6 100644 --- a/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md @@ -1,11 +1,12 @@ --- -name: Feature Request -about: Suggest a feature for blobstream-sn +name: Feature request +about: suggest new feature title: "feat: " -labels: "enhancement" +labels: "feature" assignees: "" --- + ## References diff --git a/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md b/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md index e7c266b..d562cad 100644 --- a/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/02_BUG_REPORT.md @@ -1,6 +1,6 @@ --- -name: Bug Report -about: Create bug report +name: Bug report +about: create bug report title: "bug: " labels: "bug" assignees: "" diff --git a/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md b/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md index 26ad137..fe47b44 100644 --- a/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md +++ b/.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md @@ -1,6 +1,6 @@ --- -name: Codebase Improvement -about: Docs, CI, tooling, and general suggestions +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 index 465305e..1c79151 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,14 @@ -Issue Number: N/A -Breaking Change: [ ] +--- +title: {{ env.GITHUB_BASE_REF }} +--- + -## Type + + +## Issue Number: N/A - [ ] feat - [ ] bug - [ ] dev (no functional changes) - + diff --git a/.gitignore b/.gitignore index 6890401..6f04aee 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,6 @@ Cargo.lock # Starkli **/account.json -**/keystore.json \ No newline at end of file +**/keystore.json + +**/.DS_Store \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4edc1e1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +## ๐Ÿ› ๏ธ Contributing to Blobstream-SN ๐Ÿ› ๏ธ + +Welcome, welcome, contributing to blobstream-sn is easy! + +1. Submit or comment your intent on an issue +2. We will try to respond quickly +3. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository and develop +4. Submit your PR against `main` +5. Address PR Review + +### Issue + +Project tracking is done via GitHub [issues](https://github.com/keep-starknet-strange/blobstream-sn/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](https://github.com/keep-starknet-strange/blobstream-sn/issues/new): + +> `feat:`, `bug:`, `dev:` + +Your branch must be prefixed in the following issue map (`type`, `title:`, `branch-prefix/`): + +- `Feature request` -> `feat:` -> `feat/{issue #}-{issue name}` +- `Bug report` -> `bug:` -> `bug/{issue #}-{issue name}` +- `Codebase improvement` -> `dev:` -> `dev/{issue #}-{issue name}` + +#### Bug Reports +Please try to create bug reports that are: + +- _Reproducible._ Include steps to reproduce the problem. +- _Specific._ Include as much detail as possible: which version, what environment, etc. +- _Unique._ Do not duplicate existing opened issues. +- _Scoped to a Single Bug._ One bug per report. + +### 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 blobstream-sn contributor. + +General info on [syncing a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). + +***ping the [TG](https://t.me/+N7UqCg2hxA4wNTZh) for questions*** + +## + +Thank you for your contribution! diff --git a/README.md b/README.md index 397f251..397c839 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@
- + + [![Check Workflow Status](https://github.com/keep-starknet-strange/blobstream-sn/actions/workflows/check.yml/badge.svg)](https://github.com/keep-starknet-strange/blobstream-sn/actions/workflows/check.yml) [![Build Workflow Status](https://github.com/keep-starknet-strange/blobstream-sn/actions/workflows/build.yml/badge.svg)](https://github.com/keep-starknet-strange/blobstream-sn/actions/workflows/build.yml) @@ -10,14 +11,14 @@ [![Exploration_Team](https://img.shields.io/badge/Exploration_Team-29296E.svg?&style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iNDAiIHpvb21BbmRQYW49Im1hZ25pZnkiIHZpZXdCb3g9IjAgMCAzMCAzMCIgaGVpZ2h0PSI0MCIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCIgeG1sbnM6dj0iaHR0cHM6Ly92ZWN0YS5pby9uYW5vIj48ZGVmcz48ZmlsdGVyIHg9IjAlIiB5PSIwJSIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgaWQ9IkEiPjxmZUNvbG9yTWF0cml4IHZhbHVlcz0iMCAwIDAgMCAxIDAgMCAwIDAgMSAwIDAgMCAwIDEgMCAwIDAgMSAwIiBjb2xvci1pbnRlcnBvbGF0aW9uLWZpbHRlcnM9InNSR0IiLz48L2ZpbHRlcj48ZmlsdGVyIHg9IjAlIiB5PSIwJSIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgaWQ9IkIiPjxmZUNvbG9yTWF0cml4IHZhbHVlcz0iMCAwIDAgMCAxIDAgMCAwIDAgMSAwIDAgMCAwIDEgMC4yMTI2IDAuNzE1MiAwLjA3MjIgMCAwIiBjb2xvci1pbnRlcnBvbGF0aW9uLWZpbHRlcnM9InNSR0IiLz48L2ZpbHRlcj48Y2xpcFBhdGggaWQ9IkMiPjxwYXRoIGQ9Ik0uNDg0IDBoMjkuMDMxdjI5SC40ODR6bTAgMCIgY2xpcC1ydWxlPSJub256ZXJvIi8+PC9jbGlwUGF0aD48bWFzayBpZD0iRCI+PGcgZmlsdGVyPSJ1cmwoI0EpIj48ZyBmaWx0ZXI9InVybCgjQikiIHRyYW5zZm9ybT0ibWF0cml4KDEuNDUxNjEzIDAgMCAxLjQ1MTYxMyAuNDgzODcgLjAwMDAwMikiPjxpbWFnZSB3aWR0aD0iMjAiIHhsaW5rOmhyZWY9ImRhdGE6aW1hZ2UvcG5nO2Jhc2U2NCxpVkJPUncwS0dnb0FBQUFOU1VoRVVnQUFBQlFBQUFBVUNBQUFBQUNvNGtMUkFBQUFBbUpMUjBRQS80ZVB6TDhBQUFFTFNVUkJWQmlWWlpHeFNnTkJGRVZQeGlHRVlRc0pFc1RPTDdDM2t2eUZyYVFUb242RFdGa3M0Mkpwa1NxVmxaK1NEN0JjVnJPcEpIR1puYmtXbTAzanF5NjNlT2R4M3VEa3h3QW1iWmRjTzVPQTVCalJUUzdsK3pqQzlWMEk4bDEyT01DUUs4UVlWRmpibDVhNVFwU0Ntak1NT0FOd3VnWm83ZWIyYXA0QU12QzdtMHBOa01wS3lpSERrVXQxcWFoNm9ZN205bHd0bmxiVFJ6VXhCbmxZS2tRRjFWTllLVWd4YUdrQXNPM1l3OTNhdHNrQVIrL0hseEhGd1Z2NmFMNHVURXoyWlliRGQwdS9KWlcxVk9ESUlKZXFVZ3FOcXRudUZUS2I0T0Z6TTN5bXRhbWQvSjV2SU9IQU1ObnR3ZmZZWG9nZEZ0MWhIbk93QkIydDZOWDFrcjE2bll3RzQrMy9kL3dCVTArdjhmNXlrYW9BQUFBQVNVVk9SSzVDWUlJPSIgaGVpZ2h0PSIyMCIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCIvPjwvZz48L2c+PC9tYXNrPjwvZGVmcz48ZyBjbGlwLXBhdGg9InVybCgjQykiPjxnIG1hc2s9InVybCgjRCkiPjxnIHRyYW5zZm9ybT0ibWF0cml4KDEuNDUxNjEzIDAgMCAxLjQ1MTYxMyAuNDgzODcgLjAwMDAwMikiPjxpbWFnZSB3aWR0aD0iMjAiIHhsaW5rOmhyZWY9ImRhdGE6aW1hZ2UvcG5nO2Jhc2U2NCxpVkJPUncwS0dnb0FBQUFOU1VoRVVnQUFBQlFBQUFBVUNBSUFBQUFDNjRwYUFBQUFCbUpMUjBRQS93RC9BUCtndmFlVEFBQUJ5a2xFUVZRNGpXVlV5M2FyTUF3Y2FVeG9UOXRsL3YvL2JsYVhwRTBCUGJvUU9LVFZDdVNaa1QyV0paa1Q4SUdudUFEblpibEhPQUJWbms2dmxYeUdUWktaZ0FQY1UzTkVSSVI3aWlpQXpGQVZWU1VWR0hlWUEyd0FBSXFVQ3N6RTNRR0lxQ29BUktoWmtBQklBa0FIYStuVUQ0RE1Cek1DRVZBRnFlN09yZElETFAwTHdEeC9BMWE3L1J0bVg4UHdQZ3d2UFZPNDJkMEFUTk0xUW80RTNYWG0yVVZlSTJ4ZDcyWUxNRmZsZnhIdlpuQjNVdWZaWDE1NDJFMGRPMGl0Wkdaa1loaEkzaVF6elQ2N3R3VlYzYzRNd014YWEwY3Q5MmhOaHVHdExjczlNN3REQUZUVnpJcS9MTjRhajB4VkFHb1dtWGVOOENPem9yVm01dTVCaWo3YjEvMlBjUDJqdXNYcHRCVmNGcy9jbG40SnFTb3pvL1I2OGZwMkQxSmJvN3QxUUY5U3BXVG11bjZhSmFsSHBwbVJUZmFMS3hkL0dhYkFSVlZGa0xuVnpVUkV0UFpnQXFoYkxDWkpWUVV1MVdHem1XUjZoR2ZLdXNZNFBqbThGOC9yOWV0OFByc2I2Y0Q0MUo3citqM1AvMCtuajc5TUFPNnB5bkY4dE9jVHVlSit2OVcrOW12djV0WERQcmk5YWV6bmN6ZVM3cHYvblNrQ0VmNENWOTk1cjAvV2t4U3pLT255VmxYSi9teTMrYUhBZEJnakFFYnlOZ3h2Skd1a2tCeUdOL0oyR0NNQUNFdy9EU2xMWS8wb1VrZ0FBQUFBU1VWT1JLNUNZSUk9IiBoZWlnaHQ9IjIwIiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJ4TWlkWU1pZCBtZWV0Ii8+PC9nPjwvZz48L2c+PC9zdmc+)](https://github.com/keep-starknet-strange) - Celestia *->* Starknet messaging +
- Blobstream Starknet is a port of [Celestia blobstream contracts](https://github.com/celestiaorg/blobstream-contracts) in [Cairo](https://book.cairo-lang.org/) for [Starknet](https://starknet.io/). +## Overview - **This project is under active development and should not be used in production** - +`blobstream-sn` is a port of Celestia Blobstream [contracts](https://github.com/celestiaorg/blobstream-contracts) +in [Cairo](https://book.cairo-lang.org/) for [Starknet](https://starknet.io/). -## ๐Ÿ› ๏ธ Build +## Build To build the project, run: @@ -25,7 +26,7 @@ To build the project, run: scarb build ``` -## ๐Ÿงช Test +## Test To test the project, run: @@ -33,16 +34,8 @@ To test the project, run: snforge ``` -## ๐Ÿ“š Resources - -Here are some resources to help you get started: +## -- [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/) - -## ๐Ÿ“– License - -This project is licensed under the **MIT license**. See [LICENSE](LICENSE) for more information. +
+ We live on contributions, follow the guide here! +
diff --git a/docs/images/blobstreamSnBanner.png b/docs/images/blobstreamSnBanner.png index 84db918..52a46e0 100644 Binary files a/docs/images/blobstreamSnBanner.png and b/docs/images/blobstreamSnBanner.png differ