Initial work to setup the art/peace contract with some basic tests. A…

…lso github repo setup like CONTRIBUTING.md, github workflows, and more.

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @b-j-roberts

.github/ISSUE_TEMPLATE/01_FEATURE_REQUEST.md

@@ -0,0 +1,11 @@
+---
+name: Feature request
+about: suggest new feature
+title: "[feat] "
+labels: "feature"
+assignees: ""
+---
+
+<!-- feature description -->
+
+#### References

.github/ISSUE_TEMPLATE/02_BUG_REPORT.md

@@ -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:**

.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md

@@ -0,0 +1,7 @@
+---
+name: Codebase improvement
+about: docs, ci, tooling, other
+title: "[dev] "
+labels: "dev"
+assignees: ""
+---

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+<!-- enter the gh issue after hash -->
+
+- [ ] issue #
+- [ ] follows contribution [guide](https://github.com/keep-starknet-strange/art-peace/blob/main/CONTRIBUTING.md)
+- [ ] code change includes tests
+- [ ] breaking change
+
+<!-- PR description below -->

.github/linter/base_style.rb

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

.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'

.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+permissions: read-all
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: asdf-vm/actions/install@v3
+      - run: scarb fmt --check
+      - run: scarb build

.github/workflows/check.yml

@@ -0,0 +1,26 @@
+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 .github CONTRIBUTING.md
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: asdf-vm/actions/install@v3
+      - run: snforge test

.gitignore

@@ -0,0 +1,2 @@
+target
+.snfoundry_cache/

.tool-versions

@@ -0,0 +1,2 @@
+scarb 2.6.3
+starknet-foundry 0.19.0

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+## 🛠️ Contributing to art/peace 🛠️
+
+Welcome, contributing to `art/peace` 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/art-peace/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 `art/peace` 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
+```
+
+Scarb linter:
+
+```bash
+scarb fmt
+```
+
+### 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/)
+- [Syncing a Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)
+
+##
+
+Thank you for your contribution!

README.md

@@ -16,3 +16,19 @@ Some of the features include :
 
 ## References
 - [r/place technical document](https://www.redditinc.com/blog/how-we-built-rplace)
+
+## Build
+
+To build the project, run:
+
+```bash
+scarb build
+```
+
+## Test
+
+To test the project, run ( uses `snforge` ):
+
+```bash
+scarb test
+```

Scarb.lock

@@ -0,0 +1,14 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "art_peace"
+version = "0.1.0"
+dependencies = [
+ "snforge_std",
+]
+
+[[package]]
+name = "snforge_std"
+version = "0.19.0"
+source = "git+https://github.com/foundry-rs/starknet-foundry?tag=v0.19.0#a3391dce5bdda51c63237032e6cfc64fb7a346d4"

Scarb.toml

@@ -0,0 +1,17 @@
+[package]
+name = "art_peace"
+version = "0.1.0"
+edition = "2023_11"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html
+
+[dependencies]
+snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry", tag = "v0.19.0" }
+starknet = "2.6.3"
+
+[scripts]
+test = "snforge test"
+
+[[target.starknet-contract]]
+casm = true
+sierra = true