Contributing

Thank you for your interest in contributing to the OpenCode Obsidian plugin!

What We Accept

We welcome the following types of contributions:

Bug fixes
Performance improvements
Documentation improvements

Note: Core product features and major changes require prior discussion. Please open an issue first to discuss your proposal before starting work. PRs for new features submitted without prior approval may be closed.

I'm also interested in collecting a set of Agent Skills useful in the context of Obsidian vaults. Feel free to submit an issue or PR with your ideas.

Development Setup

Requirements

Bun 1.3+
Obsidian (for testing the plugin)

Getting Started

git clone https://github.com/mtymek/opencode-obsidian.git
cd opencode-obsidian
bun install

Development Workflow

To work on the plugin during development:

Build the plugin:

bun run build  # One-time production build

The plugin will be built to main.js in the project root
For testing in Obsidian:
- Enable Community Plugins in Obsidian settings
- Copy the built plugin to your vault's .obsidian/plugins/opencode-obsidian/ directory
- Reload Obsidian or use the "Reload app without saving" command

Commands

bun install    # Install dependencies
bun run build  # Production build with type checking
bun test       # Run tests

Before Submitting a PR

Run bun run build to ensure type checking passes
Run bun test to ensure all tests pass
Test the plugin in Obsidian to verify functionality

Pull Requests

Keep PRs small and focused on a single concern
Explain what your PR is attempting to fix or improve
Link any relevant issues in the PR description

License

By contributing to the OpenCode Obsidian plugin, you agree to license your contribution under the MIT License.

1.9 KiB Raw Blame History