Skip to content

A fast, helpful, and open-source document parser

nits

Logan Markewichfba56e41cc02
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 26e4330..376b0b0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,6 +19,22 @@ Thank you for your interest in contributing to LiteParse! This document provides
npm run build
```
+## What to Contribute?
+
+In this project, we welcome a wide range of contributions, but we do want to maintain the spirit of the project. We are primarily focused on:
+
+- Core algorithms for PDF parsing and text extraction
+- OCR integrations and improvements
+- Different types or modifications to output formats
+
+We are less interested in:
+
+- Markdown output
+- Any LLM integration or agent code
+- Anything that doesn't directly relate to improving the core parsing and extraction capabilities
+
+While the project is in Typescript today, I'm pretty open to porting to Rust if someone wanted to take that on as a contribution. The core algorithms and logic would be the same, just implemented in Rust instead of Typescript.
+
## Development Workflow
### Building
@@ -45,7 +61,7 @@ npm run format # Format code with Prettier
### Testing Local Changes
-You can test your changes locally without installing globally:
+You can test your changes locally:
```bash
# Parse a document
@@ -57,48 +73,26 @@ You can test your changes locally without installing globally:
## Making Changes
-### Changesets
+### Versioning & Changelogs
-We use [Changesets](https://github.com/changesets/changesets) to manage versioning and changelogs. When you make a change that should be released:
+We use [Changesets](https://github.com/changesets/changesets) to manage versioning and changelogs. When you make a change to source code that should be released:
1. Run `npm run changeset`
2. Select the type of change (patch, minor, major)
3. Write a description of your changes
4. Commit the generated changeset file with your PR
-**When to add a changeset:**
-- Bug fixes (patch)
-- New features (minor)
-- Breaking changes (major)
-- Performance improvements (patch or minor)
-
-**When NOT to add a changeset:**
-- Documentation-only changes
-- CI/tooling changes
-- Test-only changes
-
-### Code Style
-
-- We use TypeScript with strict mode
-- Code is formatted with Prettier
-- Follow existing patterns in the codebase
-
-### Commit Messages
-
-Use clear, descriptive commit messages. We don't enforce a specific format, but prefer:
-- Start with a verb (Add, Fix, Update, Remove, etc.)
-- Keep the first line under 72 characters
-- Reference issues when applicable
-
## Pull Requests
-1. Create a feature branch from `main`
+1. Fork and create a feature branch from `main`
2. Make your changes
3. Add a changeset if needed (`npm run changeset`)
4. Ensure all tests pass (`npm test`)
-5. Ensure linting passes (`npm run lint`)
+5. Ensure linting passes (`npm run lint:fix` and `npm run format`)
6. Submit a pull request
+When you submit a PR, a number of CICD checks will run. Among these, your code will be tested against a regression suite of documents to ensure that your changes don't break existing parsing capabilities. It will be up to the maintainers discretion to determine if any changes to the regression set are expected/positive or unexpected/negative.
+
### PR Guidelines
- Keep PRs focused on a single change
diff --git a/SECURITY.md b/SECURITY.md
index 497a31a..43ac5b4 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,11 +1,5 @@
# Security Policy
-## Supported Versions
-
-| Version | Supported |
-| ------- | ------------------ |
-| 0.x.x | :white_check_mark: |
-
## Reporting a Vulnerability
If you discover a security vulnerability in LiteParse, please report it responsibly:
@@ -30,33 +24,21 @@ Security issues we will address:
### Out of Scope
-LiteParse is a **local CLI tool and library** designed to process documents you provide. The following are **not** security vulnerabilities we will address:
+LiteParse is intended to be a local CLI tool and library, designed to process documents you provide. The following are not security vulnerabilities we will address:
- **Malicious input files** - Processing untrusted documents (zip bombs, malformed PDFs, path traversal in filenames, etc.) is the user's responsibility. If you're building a service that accepts untrusted uploads, you must implement your own validation, sandboxing, and resource limits.
- **Denial of service via large/complex files** - Documents that cause high memory usage, long processing times, or crashes are not security issues. Use `--max-pages`, timeouts, and resource limits in your deployment.
-- **Issues requiring a server setup** - LiteParse does not include or recommend any specific server deployment. Security of web services built on top of LiteParse is the deployer's responsibility.
+- **Issues requiring a server setup** - LiteParse does not include or recommend any specific production server deployment. Security of web services built on top of LiteParse is the deployer's responsibility.
- **Theoretical attacks without proof of concept** - Please include a working demonstration.
### Building Secure Services
If you're exposing LiteParse through a web service or API:
-1. **Validate uploads** - Check file types, sizes, and origins before processing
-2. **Use sandboxing** - Run parsing in isolated containers with resource limits
-3. **Set timeouts** - Don't allow unbounded processing time
-4. **Limit concurrency** - Prevent resource exhaustion from parallel requests
-5. **Don't trust filenames** - Sanitize any paths derived from user input
+1. Validate uploads: Check file types, sizes, and origins before processing
+2. Use sandboxing: Run parsing in isolated containers with resource limits
+3. Set timeouts: Don't allow unbounded processing time
+4. Limit concurrency: Prevent resource exhaustion from parallel requests
+5. Don't trust filenames: Sanitize any paths derived from user input
These concerns are standard for any document processing service and are outside LiteParse's scope.
-
-## Response Timeline
-
-- We will acknowledge receipt within 48 hours
-- We will provide an initial assessment within 7 days
-- We aim to release patches for critical vulnerabilities within 30 days
-
-## Disclosure Policy
-
-- We will coordinate disclosure timing with reporters
-- We will credit reporters in release notes (unless they prefer anonymity)
-- We follow responsible disclosure practices