Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.75 KB

File metadata and controls

33 lines (20 loc) · 1.75 KB

Contributing to Minimal

Minimal is considered feature complete. The main goal going forward is keeping it up to date with new Obsidian releases, so the most useful contributions are bug fixes and compatibility patches for new Obsidian versions. New features are unlikely to be merged.

Reporting issues

Before opening an issue, please search existing issues to avoid duplicates. When reporting a bug, include:

  • Obsidian version and operating system
  • Minimal version
  • Steps to reproduce, and a screenshot if relevant
  • Whether the issue occurs with other themes disabled

Submitting pull requests

  1. Fork the repo and create a branch from master.
  2. Make your changes in src/scss. Never edit obsidian.css or Minimal.css directly, as these are generated.
  3. Build locally and test in Obsidian (see build instructions).
  4. Open a pull request with a short description of what changed and why.

Keep PRs focused. One fix or feature per PR makes review easier.

Adding plugin support

Plugin styles live in src/scss/plugins. Use existing files as a template, and try to follow Minimal's color variables and spacing conventions so the plugin feels at home.

Improving the documentation

The documentation site at minimal.guide is published from the docs folder in this repo. If you spot something out of date, missing, or unclear, edits and additions are welcome. Just open a PR against the relevant files in docs.

Questions

Join the Minimal channel on the official Obsidian Discord.