Skip to content

Commit

Permalink
Merge pull request #2 from keep-starknet-strange/dev/gh-flow
Browse files Browse the repository at this point in the history
dev: gh flow
  • Loading branch information
drspacemn committed Jan 19, 2024
2 parents 02997c7 + 5c7f5c2 commit ba0809a
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 31 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -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: ""
---

<!-- Description -->


## References
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/02_BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug Report
about: Create bug report
name: Bug report
about: create bug report
title: "bug: "
labels: "bug"
assignees: ""
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -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: ""
Expand Down
12 changes: 8 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Issue Number: N/A
Breaking Change: [ ] <!-- [x] if breaking -->
---
title: {{ env.GITHUB_BASE_REF }}
---
<!--TODO does env need to be changed?-->

## Type
<!-- uncomment line below if change is breaking -->
<!-- ## CHANGE IS BREAKING -->
## Issue Number: N/A

- [ ] feat
- [ ] bug
- [ ] dev (no functional changes)

<!-- Description -->
<!-- Description Below -->
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ Cargo.lock

# Starkli
**/account.json
**/keystore.json
**/keystore.json

**/.DS_Store
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,40 @@
<!-- markdownlint-disable -->

<div align="center">
<img src="docs/images/blobstreamSnBanner.png" height="250" />
<img style="margin-bottom: 3px" src="docs/images/blobstreamSnBanner.png" height="300" />


[![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)

[![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
</div>

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**
</div>
`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:

```bash
scarb build
```

## 🧪 Test
## Test

To test the project, run:

```bash
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.
<div align="center">
<b>We live on contributions, follow the guide <a href="CONTRIBUTING.md">here</a>!</b>
</div>
Binary file modified docs/images/blobstreamSnBanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ba0809a

Please sign in to comment.