Merge pull request #3 from keep-starknet-strange/1-feat-gh-test

feat: gh test

.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md

@@ -8,5 +8,4 @@ assignees: ""
 
 <!-- Description -->
 
-
 ## References

.github/ISSUE_TEMPLATE/02_BUG_REPORT.md

@@ -10,5 +10,4 @@ assignees: ""
 
 <!-- Description(current vs expected behavior) -->
 
-
 **How to reproduce:**

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,4 @@
----
-title: {{ env.GITHUB_BASE_REF }}
----
-<!--TODO does env need to be changed?-->
-
-<!-- uncomment line below if change is breaking -->
-<!-- ## CHANGE IS BREAKING -->
-## Issue Number: N/A
-
-- [ ] feat
-- [ ] bug
-- [ ] dev (no functional changes)
+<!-- markdownlint-disable-next-line MD026 -->
+## `blobstream-sn` Issue #
 
 <!-- Description Below -->

.github/workflows/build.yml

@@ -1,7 +1,11 @@
 name: build
 
-on: [push, pull_request]
-
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
 permissions: read-all
 
 jobs:

.github/workflows/check.yml

@@ -1,10 +1,24 @@
 name: check
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
 permissions: read-all
 
 jobs:
-  check:
+  markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: |
+          sudo gem install mdl
+          mdl -s docs/linter/readme_style.rb README.md
+          mdl -s docs/linter/base_style.rb CONTRIBUTING.md docs .github
+
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -1,17 +1,5 @@
-# Generated by Cargo
-# will have compiled files and executables
-debug/
-target/
-
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
-
-# MSVC Windows builds of rustc generate these, which store debugging information
-*.pdb
+# Sys files
+**/.DS_Store
 
 # Scarb and Starknet Foundry
 **/target
@@ -20,5 +8,3 @@ Cargo.lock
 # Starkli
 **/account.json
 **/keystore.json
-
-**/.DS_Store

CONTRIBUTING.md

@@ -3,16 +3,16 @@
 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
+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/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.
+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):
 
@@ -24,22 +24,23 @@ Your branch must be prefixed in the following issue map (`type`, `title:`, `bran
 - `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.
+will review your work. Address changes, ensure ci passes,
+and voilà you're a blobstream-sn contributor.
+
+### Additional Resources
 
-General info on [syncing a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).
+Here are some resources to help you get started:
 
-***ping the [TG](https://t.me/+N7UqCg2hxA4wNTZh) for questions***
+- [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)
 
 ##
 

README.md

@@ -1,21 +1,16 @@
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-
 <div align="center">
-  <img style="margin-bottom: 3px" src="docs/images/blobstreamSnBanner.png" height="300" />
-
+  <img style="margin-bottom: 3px" src="docs/images/blobstreamSnBanner.png" height="250"/>
 
   [![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)
 
-
 </div>
 
 ## Overview
 
-`blobstream-sn` is a port of Celestia Blobstream [contracts](https://github.com/celestiaorg/blobstream-contracts) 
+`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

docs/linter/base_style.rb

@@ -0,0 +1,4 @@
+all
+# lame rules
+exclude_rule 'MD002'
+exclude_rule 'MD041'

docs/linter/readme_style.rb

@@ -0,0 +1,8 @@
+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'