SoulCache
Contributing

Contributing

How to contribute to SoulCache

We welcome contributions to SoulCache!

Getting Started

Fork and Clone

Fork the repository on GitHub, then clone your fork:

git clone https://github.com/your-username/soulcache.git
cd soulcache

Install Dependencies

pnpm install

Create a Branch

git checkout -b feature/my-feature

Make Changes and Test

Make your changes, then run the test suite:

pnpm test

Commit and Push

git commit -m "feat: add my feature"
git push origin feature/my-feature

Create a Pull Request

Open a pull request on GitHub with a clear description of your changes.

Development

Project Structure

Repository Structure
soulcache
│ packages
│ │ core/Core runtime
│ │ react/React bindings
│ │ devtools-core/DevTools core
│ │ devtools/DevTools React panel
│ │ examples/Example projects
│ docs
│ scripts

Scripts

Available Scripts
# Run tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run benchmarks
pnpm benchmark

# Build packages
pnpm build

# Lint code
pnpm lint

# Type check
pnpm typecheck

Code Style

Coding Standards

  • Use TypeScript with strict mode
  • Follow existing patterns in the codebase
  • Write tests for new features
  • Update documentation for API changes

Pull Request Guidelines

PR Checklist

  • Write clear, descriptive commit messages
  • Include tests for new features
  • Update documentation as needed
  • Follow existing code style and conventions
Previous
PluginManager
Next
Security

On this page