chorse: Improve quality of repo

Author: matzehuels

.gitattributes

@@ -0,0 +1,61 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Go source files
+*.go text eol=lf
+
+# Bash scripts
+*.sh text eol=lf
+
+# Markdown and documentation
+*.md text eol=lf
+
+# JSON and data files
+*.json text eol=lf
+*.xml text eol=lf
+*.toml text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+
+# Lock files (generated, but treat as text)
+*.lock text eol=lf linguist-generated=true
+
+# Binary files
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.svg binary
+*.pdf binary
+*.woff binary
+*.woff2 binary
+
+# SVG files - mark as generated/binary to avoid noisy diffs in examples
+*.svg linguist-generated=true
+
+# Output and coverage files - mark as generated
+*.out linguist-generated=true
+coverage*.out linguist-generated=true
+
+# Example outputs - mark as generated
+/output/** linguist-generated=true
+/examples/real/*.json linguist-generated=true
+/examples/test/*.json linguist-generated=true
+
+# Cache files
+/blogpost/cache/** linguist-generated=true
+
+# Archive files
+*.zip binary
+*.tar binary
+*.gz binary
+*.tgz binary
+*.bz2 binary
+
+# Go binaries
+/bin/* binary
+
+# Treat go.sum as generated (don't show in diffs by default on GitHub)
+go.sum linguist-generated=true
+

.github/CODEOWNERS

@@ -0,0 +1,30 @@
+# CODEOWNERS
+# 
+# This file defines individuals or teams responsible for code in this repository.
+# Code owners are automatically requested for review when someone opens a pull request
+# that modifies code that they own.
+#
+# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# Default owner for everything in the repo
+* @matzehuels
+
+# Core packages
+/pkg/ @matzehuels
+/internal/ @matzehuels
+
+# CI/CD and infrastructure
+/.github/ @matzehuels
+/Makefile @matzehuels
+
+# Documentation
+/README.md @matzehuels
+/CONTRIBUTING.md @matzehuels
+/CODE_OF_CONDUCT.md @matzehuels
+/SECURITY.md @matzehuels
+/blogpost/ @matzehuels
+
+# Dependencies
+/go.mod @matzehuels
+/go.sum @matzehuels
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,136 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement via:
+
+- GitHub Issues (for non-sensitive matters)
+- Direct contact with the maintainer (see GitHub profile)
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -40,6 +40,116 @@ make e2e        # End-to-end tests
 make cover      # Tests with coverage
 ```
 
+## Architecture
+
+Stacktower follows a clean layered architecture. See the [pkg.go.dev documentation](https://pkg.go.dev/github.com/matzehuels/stacktower) for detailed API docs.
+
+```
+internal/cli/          # Command-line interface
+pkg/dag/               # Core DAG data structure
+├── transform/         # Graph normalization (transitive reduction, subdivision)
+└── perm/              # PQ-tree and permutation algorithms
+pkg/deps/              # Dependency resolution from registries
+├── python/            # Python: PyPI + poetry.lock + requirements.txt
+├── rust/              # Rust: crates.io + Cargo.toml
+├── javascript/        # JavaScript: npm + package.json
+├── ruby/              # Ruby: RubyGems + Gemfile
+├── php/               # PHP: Packagist + composer.json
+├── java/              # Java: Maven Central + pom.xml
+├── golang/            # Go: Go Module Proxy + go.mod
+└── metadata/          # GitHub/GitLab enrichment providers
+pkg/integrations/      # Registry API clients (npm, pypi, crates, etc.)
+pkg/render/tower/      # Tower visualization
+├── ordering/          # Barycentric and optimal ordering algorithms
+├── layout/            # Block position computation
+├── sink/              # Output formats (SVG, JSON, PDF, PNG)
+└── styles/            # Visual styles (handdrawn, simple)
+pkg/io/                # JSON import/export
+```
+
+## Adding a New Language
+
+1. **Create an integration client** in `pkg/integrations/<registry>/client.go`:
+
+```go
+type Client struct {
+    *integrations.Client
+    baseURL string
+}
+
+func NewClient(cacheTTL time.Duration) (*Client, error) {
+    cache, err := integrations.NewCache(cacheTTL)
+    if err != nil {
+        return nil, err
+    }
+    return &Client{
+        Client:  integrations.NewClient(cache, nil),
+        baseURL: "https://registry.example.com",
+    }, nil
+}
+
+func (c *Client) FetchPackage(ctx context.Context, name string, refresh bool) (*PackageInfo, error) {
+    // Implement caching and fetching
+}
+```
+
+2. **Create a language definition** in `pkg/deps/<lang>/<lang>.go`:
+
+```go
+var Language = &deps.Language{
+    Name:            "mylang",
+    DefaultRegistry: "myregistry",
+    RegistryAliases: map[string]string{"alias": "myregistry"},
+    ManifestTypes:   []string{"my.lock"},
+    ManifestAliases: map[string]string{"my.lock": "mylock"},
+    NewResolver:     newResolver,
+    NewManifest:     newManifest,
+    ManifestParsers: manifestParsers,
+}
+```
+
+3. **Register in CLI** in `internal/cli/parse.go`
+
+See [`pkg/deps`](https://pkg.go.dev/github.com/matzehuels/stacktower/pkg/deps) for detailed documentation.
+
+## Adding a Manifest Parser
+
+Implement the `ManifestParser` interface:
+
+```go
+type MyLockParser struct{}
+
+func (p *MyLockParser) Type() string              { return "my.lock" }
+func (p *MyLockParser) IncludesTransitive() bool  { return true }
+func (p *MyLockParser) Supports(name string) bool { return name == "my.lock" }
+
+func (p *MyLockParser) Parse(path string, opts deps.Options) (*deps.ManifestResult, error) {
+    g := dag.New(nil)
+    // ... populate nodes and edges
+    return &deps.ManifestResult{Graph: g, Type: p.Type(), IncludesTransitive: true}, nil
+}
+```
+
+## Adding a New Output Format
+
+Output formats are "sinks" in `pkg/render/tower/sink/`. Each sink takes a `layout.Layout` and renders it to bytes.
+
+1. **Create a sink file** in `pkg/render/tower/sink/<format>.go`:
+
+```go
+func RenderMyFormat(l layout.Layout, opts ...MyFormatOption) ([]byte, error) {
+    // Access layout data:
+    // - l.FrameWidth, l.FrameHeight: canvas dimensions
+    // - l.Blocks: map[string]Block with position data
+    // - l.RowOrders: node ordering per row
+    return []byte("..."), nil
+}
+```
+
+2. **Register in CLI** in `internal/cli/render.go`
+
+See [`pkg/render/tower/sink`](https://pkg.go.dev/github.com/matzehuels/stacktower/pkg/render/tower/sink) for existing implementations.
+
 ## Questions?
 
 Open an [issue](https://github.com/matzehuels/stacktower/issues) — we're happy to help!