Skip to content

Commit 7079de9

Browse files
committed
feat: initial ARNS marketplace Data library
1 parent b301eb3 commit 7079de9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+7543
-1
lines changed

.changeset/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
4+
with multi-package repos, or single-package repos to help you version and publish your code. You can
5+
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
6+
7+
We have a quick list of common questions to get you started engaging with this project in
8+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@2.0.0/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"updateInternalDependencies": "patch",
9+
"baseBranch": "develop",
10+
"ignore": []
11+
}

.github/workflows/check-build.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: '[CI] check build'
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- develop
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
check-build:
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 10
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Install pnpm
21+
uses: pnpm/action-setup@v4
22+
23+
- name: Install node
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: lts/*
27+
cache: 'pnpm'
28+
29+
- name: Install dependencies
30+
run: pnpm install
31+
32+
- name: Lint app
33+
run: pnpm lint
34+
35+
- name: Check for TypeScript errors
36+
run: pnpm typecheck
37+
38+
- name: Run unit tests
39+
run: pnpm test

.github/workflows/commitlint.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: '[CI] lint commits'
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- develop
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
commitlint:
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 5
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Install pnpm
23+
uses: pnpm/action-setup@v4
24+
25+
- name: Install node
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: lts/*
29+
cache: 'pnpm'
30+
31+
- name: Install dependencies
32+
run: pnpm install
33+
34+
- name: Lint commit messages in PR
35+
run: |
36+
echo "Checking commits from ${{ github.event.pull_request.base.sha }} to ${{ github.event.pull_request.head.sha }}"
37+
npx commitlint --from=${{ github.event.pull_request.base.sha }} --to=${{ github.event.pull_request.head.sha }} --verbose

.gitignore

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
*.local
13+
14+
# Editor directories and files
15+
tsconfig.tsbuildinfo
16+
.vscode/*
17+
!.vscode/settings.json
18+
!.vscode/extensions.json
19+
.idea
20+
.DS_Store
21+
*.suo
22+
*.ntvs*
23+
*.njsproj
24+
*.sln
25+
*.sw?
26+
27+
.github/*.md

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
engine-strict=true

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
**/dist
2+
**/node_modules
3+
pnpm-lock.yaml

.vscode/settings.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"typescript.tsdk": "./node_modules/typescript/lib",
3+
"eslint.useFlatConfig": true
4+
}

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# @blockydevs/arns-marketplace-data
2+
3+
## 0.1.0
4+
5+
### Minor Changes
6+
7+
- Initial release of `@blockydevs/arns-marketplace-data`

GIT_WORKFLOW.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Git Workflow & Branching Strategy
2+
3+
This document outlines the standard Git workflow for our project.
4+
5+
## 1. Branching Model
6+
7+
We follow a simplified Gitflow-like model with `main` and `develop` as our primary long-lived branches.
8+
9+
* **`main` Branch:**
10+
* Represents the **production-ready** code.
11+
* **Protected:** No direct pushes are allowed.
12+
* Only merges from the `develop` branch are permitted, typically for releases.
13+
14+
* **`develop` Branch:**
15+
* Serves as the **integration branch** for all new features and bug fixes.
16+
* **Protected:** No direct pushes are allowed.
17+
* All new work must be merged into `develop` via a Pull Request (PR) from dedicated feature/fix branches.
18+
19+
* **Feature/Fix/Hotfix Branches:**
20+
* **Purpose:** Where all active development takes place.
21+
* **Creation:** Always branched off `develop` (for features/fixes) or `main` (for critical hotfixes).
22+
* **Naming Convention:**
23+
* `feature/your-feature-name` (e.g., `feature/AM-123-new-login`)
24+
* `fix/your-bug-fix-name` (e.g., `fix/AM-456-broken-button`)
25+
* `hotfix/critical-issue` (only from `main`)
26+
27+
## 2. Commit Message Guidelines
28+
29+
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to ensure consistent and meaningful commit messages, which aids in changelog generation and understanding project history.
30+
31+
* **Format:** `<type>(<scope>): <subject>`
32+
* **Example:**
33+
* `feat: add new user registration flow`
34+
* `fix(auth): correct password reset bug`
35+
* `chore: update dependencies`
36+
* `docs: update README with new API endpoint`
37+
38+
### CI Enforcement (`commitlint`)
39+
40+
Our CI pipeline includes a `commitlint` check that runs on every Pull Request targeting the `develop` branch.
41+
This action ensures that all commit messages within your PR adhere to the Conventional Commits specification.
42+
If any commit message in your PR violates the rules, the CI check will fail, and the PR cannot be merged until corrected.

0 commit comments

Comments
 (0)