Skip to content

tzylo/synapse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tzylo Synapse

Automatic code review and documentation for every pull request.

Tzylo Synapse is a GitHub App that reviews your PRs and automatically updates TZYLO.md — a living documentation file that grows with your codebase. No manual writing. No outdated docs. Just merge and move on.

Install on GitHub


What it does

On every PR opened:

  • Reviews code for bugs, security issues, and quality problems
  • Posts a structured comment with findings and suggestions

On every PR merged:

  • Classifies changes into documentation sections
  • Appends a structured entry to TZYLO.md in your repo
  • Commits automatically — no action needed from your team

How TZYLO.md looks after a few PRs

# Tzylo Documentation
Auto-generated by Tzylo Synapse

---

## [2025-05-08] Fix: Shifted from submissionId to chunkId
**PR:** #42 | **Author:** @kbpramod

**Summary:** Renamed identifier across submission pipeline for consistency

### API Changes
- Updated POST /submit endpoint — field renamed from submissionId to chunkId
- Clients must update request payload to use chunkId

### Breaking Changes
- submissionId no longer accepted — breaking change for existing integrations
- Requires migration for downstream consumers

### Architecture
- Identifier now aligns with chunk-based data model across all services

Every PR adds an entry. Your team always knows what changed and why.


Installation

1. Install the GitHub App

Install Tzylo Synapse →

2. Grant permissions

Tzylo requires:

  • Pull requests — read and write (to post review comments)
  • Contents — read and write (to update TZYLO.md)

3. That's it

Open a PR. Tzylo will review it and comment automatically. Merge it. Tzylo will update TZYLO.md automatically.

No configuration needed.


What gets documented

Every merged PR is classified into relevant sections:

Section What it captures
API Changes New or modified endpoints
Database Changes Migrations, schema changes
Architecture Structural changes, refactors
Breaking Changes Anything that breaks existing behavior
Dependencies New packages, version updates
Configuration Environment variables, config changes
Bug Fixes Bugs resolved
General Notes Anything else worth documenting

Only relevant sections are written. Empty sections are skipped.


Why TZYLO.md

  • Lives in your repo — versioned with your code
  • Readable by anyone on the team
  • Searchable with standard tools
  • Grows automatically — no manual effort
  • Survives team changes — new engineers have full context from day one

Who is this for

Engineering teams at startups who move fast and skip documentation — until it becomes a problem. Tzylo Synapse captures institutional memory automatically so you never lose context when someone joins or leaves.


Built by

Tzylo — developer infrastructure for engineering teams.


Feedback

Found a bug or have a suggestion? Open an issue or reach out:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors