Skip to content

Commit b2dc2a8

Browse files
committed
🤖 Add community infrastructure: GitHub templates, CI workflow, contributing guide, and MIT license
* .github/ISSUE_TEMPLATE/bug_report.md: New bug report template with description, reproduction steps, expected/actual behavior, and environment fields * .github/ISSUE_TEMPLATE/feature_request.md: New feature request template with problem, proposed solution, alternatives, and context sections * .github/workflows/ci.yml: New CI workflow testing Node.js 20 and 22 with build and test steps on push/PR to
1 parent 0940150 commit b2dc2a8

18 files changed

Lines changed: 1811 additions & 251 deletions
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report
3+
about: Report a bug or unexpected behavior
4+
title: "[Bug] "
5+
labels: ["bug"]
6+
---
7+
8+
## Description
9+
A clear description of the bug.
10+
11+
## Steps to Reproduce
12+
1.
13+
2.
14+
3.
15+
16+
## Expected Behavior
17+
What you expected to happen.
18+
19+
## Actual Behavior
20+
What actually happened.
21+
22+
## Environment
23+
- Node.js version:
24+
- OS:
25+
- MemoryCore version:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement
4+
title: "[Feature] "
5+
labels: ["enhancement"]
6+
---
7+
8+
## Problem
9+
What problem are you trying to solve?
10+
11+
## Proposed Solution
12+
How do you think this should work?
13+
14+
## Alternatives
15+
Any alternative approaches you've considered?
16+
17+
## Additional Context
18+
Any other context, screenshots, or examples.

‎.github/workflows/ci.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [20, 22]
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
cache: npm
25+
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Build
30+
run: npm run build
31+
32+
- name: Test
33+
run: node --test dist/tests/*.test.js

‎CONTRIBUTING.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to AI MemoryCore
2+
3+
Thanks for your interest! Here's how to contribute.
4+
5+
## Quick Setup
6+
7+
```bash
8+
git clone https://github.com/Kiyoraka/Project-AI-MemoryCore.git
9+
cd Project-AI-MemoryCore
10+
npm install
11+
npm run dev
12+
```
13+
14+
## Development
15+
16+
```bash
17+
npm run dev # Start dev server (tsx watch)
18+
npm run build # TypeScript compile
19+
npm run test # Run tests
20+
npm run cli # Run CLI commands
21+
```
22+
23+
## Pull Requests
24+
25+
1. Fork the repo and create a branch from `main`
26+
2. Make your changes with clear commit messages
27+
3. Add tests if you're adding new features
28+
4. Ensure `npm run build` passes
29+
5. Open a PR with a description of what you changed and why
30+
31+
## Issues
32+
33+
- **Bug reports**: Include steps to reproduce, expected vs actual behavior
34+
- **Feature requests**: Describe the use case and proposed solution
35+
- **Questions**: Use GitHub Discussions if available, otherwise open an issue
36+
37+
## Code Style
38+
39+
- TypeScript strict mode
40+
- Use Zod for input validation
41+
- Keep functions focused and small
42+
- Add JSDoc comments for public APIs
43+
44+
## Architecture
45+
46+
```
47+
src/
48+
├── server.ts # Entry point
49+
├── api.ts # Fastify routes
50+
├── mcp.ts # MCP server
51+
├── service.ts # Business logic
52+
├── storage.ts # SQLite layer
53+
├── schemas.ts # Zod schemas
54+
├── config.ts # Env config
55+
└── cli.ts # CLI
56+
```
57+
58+
## License
59+
60+
By contributing, you agree that your contributions will be licensed under the MIT License.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Kiyoraka
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)