Contributing to Memos SP Plugin

June 1, 2026 ยท View on GitHub

Thank you for your interest in improving this plugin.

English-Only Rule

All contributions must be in English. This includes:

  • Code (variable names, functions, etc.)
  • Comments
  • Documentation
  • Issues
  • Pull Requests

Development Environment

For instructions on how to set up your local environment, please see docs/local-development.md.

Code Style

  • Use TypeScript.
  • Follow existing patterns in the codebase.
  • Keep functions small and focused.
  • Ensure all new files are added to the appropriate directory (src/adapters, src/engine, etc.).

Pull Request Process

  1. Create a feature branch from the main branch.
  2. Ensure your changes build and pass any existing tests.
  3. Update the documentation if you add new features or change behavior.
  4. Submit a Pull Request with a clear description of the changes.

Commit Conventions

Use concise commit messages that describe the change. For example:

  • feat: add initial memos client
  • fix: resolve token storage issue
  • docs: update installation guide