Skip to content

Commit 64eda0e

Browse files
author
shillshady
committed
add CI, issue templates, contributing guide, security policy
1 parent b87e26f commit 64eda0e

8 files changed

Lines changed: 158 additions & 1 deletion

File tree

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: shillshady
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: ""
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear description of what went wrong.
11+
12+
**To reproduce**
13+
Steps to reproduce the behavior:
14+
1. Run `solblade ...`
15+
2. See error
16+
17+
**Expected behavior**
18+
What you expected to happen.
19+
20+
**Environment**
21+
- OS: [e.g., macOS 15, Ubuntu 24.04, Windows 11]
22+
- Bun version: [e.g., 1.2.0]
23+
- Solblade version: [e.g., 0.1.0]
24+
- RPC provider: [e.g., Helius, QuickNode, public]
25+
26+
**Logs**
27+
If applicable, paste relevant terminal output or audit log entries.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
title: ""
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
**What problem does this solve?**
10+
A clear description of the problem or use case.
11+
12+
**Proposed solution**
13+
How you'd like it to work.
14+
15+
**Alternatives considered**
16+
Any other approaches you've thought about.
17+
18+
**Additional context**
19+
Screenshots, links, or examples from other tools.

.github/pull_request_template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## What
2+
3+
Brief description of the change.
4+
5+
## Why
6+
7+
Why is this needed?
8+
9+
## How
10+
11+
How was it implemented? Any notable design decisions?
12+
13+
## Testing
14+
15+
- [ ] `bun run build` passes
16+
- [ ] Tested manually with `bun run dev`

.github/workflows/ci.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- uses: oven-sh/setup-bun@v2
16+
with:
17+
bun-version: latest
18+
19+
- run: bun install --frozen-lockfile
20+
21+
- run: bun run build

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to Solblade
2+
3+
Thanks for your interest in contributing.
4+
5+
## Getting Started
6+
7+
```bash
8+
git clone https://github.com/shillshady/solblade.git
9+
cd solblade
10+
bun install
11+
bun run dev
12+
```
13+
14+
## Pull Requests
15+
16+
1. Fork the repo and create a branch from `main`
17+
2. Keep changes focused — one feature or fix per PR
18+
3. Make sure `bun run build` passes before submitting
19+
4. Write a clear PR description explaining what changed and why
20+
21+
## Issues
22+
23+
- Use the bug report template for bugs
24+
- Use the feature request template for ideas
25+
- Search existing issues before opening a new one
26+
27+
## Code Style
28+
29+
- TypeScript with strict mode
30+
- Descriptive variable names
31+
- Functions under 30 lines where possible
32+
- Guard clauses over deep nesting
33+
34+
## Security
35+
36+
If you find a security vulnerability, **do not open a public issue**. See [SECURITY.md](SECURITY.md) for responsible disclosure instructions.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88
</p>
99

1010
<p align="center">
11-
<a href="https://www.npmjs.com/package/solblade"><img src="https://img.shields.io/npm/v/solblade?style=flat-square&color=00ffc8" alt="npm" /></a>
11+
<a href="https://github.com/shillshady/solblade/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/shillshady/solblade/ci.yml?style=flat-square&label=CI" alt="CI" /></a>
1212
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="license" /></a>
1313
<a href="https://bun.sh"><img src="https://img.shields.io/badge/runtime-Bun-f472b6?style=flat-square" alt="bun" /></a>
1414
<a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/protocol-MCP-7c3aed?style=flat-square" alt="MCP" /></a>
15+
<a href="https://github.com/shillshady/solblade/stargazers"><img src="https://img.shields.io/github/stars/shillshady/solblade?style=flat-square&color=f5c542" alt="stars" /></a>
1516
</p>
1617

1718
<p align="center">

SECURITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| 0.1.x | Yes |
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability in Solblade, **do not open a public issue**.
12+
13+
Instead, please report it privately by emailing **shillshady@proton.me** with:
14+
15+
- Description of the vulnerability
16+
- Steps to reproduce
17+
- Potential impact
18+
- Suggested fix (if any)
19+
20+
You will receive a response within 72 hours. Critical issues will be patched and released as soon as possible.
21+
22+
## Scope
23+
24+
The following are in scope for security reports:
25+
26+
- Keystore encryption weaknesses
27+
- MCP server permission bypasses
28+
- Session/authentication flaws
29+
- Private key exposure vectors
30+
- Audit log tampering
31+
32+
Out of scope:
33+
34+
- Issues in upstream dependencies (report those to the dependency maintainer)
35+
- Social engineering attacks
36+
- Denial of service via excessive CLI usage

0 commit comments

Comments
 (0)