Skip to content

Commit 25b57d7

Browse files
singularityjasonclaude
authored andcommitted
docs: add badges, star history, CI, issue templates, contributing guide
Phase 1 repository optimization for GitHub distribution: - Add PyPI, Python version, and MIT license badges - Add star-history chart - Create CI workflow (Python 3.10-3.13 test matrix) - Create bug report and feature request issue templates - Create PR template - Create CONTRIBUTING.md and CODE_OF_CONDUCT.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9e01377 commit 25b57d7

7 files changed

Lines changed: 145 additions & 0 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in Lightning Memory
4+
title: "[Bug] "
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear description of what the bug is.
10+
11+
**To reproduce**
12+
Steps to reproduce the behavior.
13+
14+
**Expected behavior**
15+
What you expected to happen.
16+
17+
**Environment**
18+
- Python version:
19+
- lightning-memory version:
20+
- OS:
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a feature for Lightning Memory
4+
title: "[Feature] "
5+
labels: enhancement
6+
---
7+
8+
**Problem**
9+
What problem does this solve?
10+
11+
**Proposed solution**
12+
How should it work?
13+
14+
**Alternatives considered**
15+
Any other approaches you've thought about.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## What
2+
3+
<!-- Brief description of changes -->
4+
5+
## Why
6+
7+
<!-- Motivation / issue link -->
8+
9+
## Checklist
10+
11+
- [ ] Tests pass (`pytest tests/`)
12+
- [ ] Documentation updated (if applicable)

.github/workflows/test.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ["3.10", "3.11", "3.12", "3.13"]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -e ".[dev]"
28+
29+
- name: Run tests
30+
run: pytest tests/ -v

CODE_OF_CONDUCT.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to making participation in this project a welcoming experience for everyone, regardless of background or identity.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
16+
Examples of unacceptable behavior:
17+
18+
- Trolling, insulting/derogatory comments, and personal attacks
19+
- Public or private harassment
20+
- Publishing others' private information without explicit permission
21+
- Other conduct which could reasonably be considered inappropriate in a professional setting
22+
23+
## Enforcement
24+
25+
Instances of unacceptable behavior may be reported by opening a GitHub issue or contacting the maintainers directly. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
26+
27+
## Attribution
28+
29+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to Lightning Memory
2+
3+
Thanks for your interest in contributing!
4+
5+
## Development Setup
6+
7+
```bash
8+
git clone https://github.com/singularityjason/lightning-memory
9+
cd lightning-memory
10+
pip install -e ".[dev]"
11+
pytest tests/
12+
```
13+
14+
## How to Contribute
15+
16+
1. Fork the repository
17+
2. Create a feature branch (`git checkout -b feature/my-feature`)
18+
3. Make your changes
19+
4. Run tests (`pytest tests/`)
20+
5. Commit and push
21+
6. Open a Pull Request
22+
23+
## Reporting Bugs
24+
25+
Use the [bug report template](https://github.com/singularityjason/lightning-memory/issues/new?template=bug_report.md).
26+
27+
## Code Style
28+
29+
- Follow existing patterns in the codebase
30+
- Keep functions focused and small
31+
- Add tests for new functionality

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Lightning Memory
22

3+
[![PyPI version](https://img.shields.io/pypi/v/lightning-memory.svg)](https://pypi.org/project/lightning-memory/)
4+
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
5+
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
6+
37
Decentralized agent memory for the Lightning economy. Store, query, and recall memories with cryptographic identity (Nostr) and micropayments (Lightning/L402).
48

59
**The problem:** AI agents can transact via Lightning (L402) but can't remember what they paid for, which vendors are reliable, or their spending patterns. Lightning Memory fixes this.
@@ -262,6 +266,10 @@ All data is stored locally:
262266
- [x] Phase 3: Nostr relay sync (NIP-78 events, Schnorr signing, bidirectional sync)
263267
- [x] Phase 4: L402 payment gateway (macaroons, Phoenixd, Starlette HTTP gateway)
264268

269+
## Star History
270+
271+
[![Star History Chart](https://api.star-history.com/svg?repos=singularityjason/lightning-memory&type=Date)](https://star-history.com/#singularityjason/lightning-memory&Date)
272+
265273
## License
266274

267275
MIT

0 commit comments

Comments
 (0)