obsidian-plugin/mnaoumov_obsidian-smart-rename
1
0
Fork 0
mirror of https://github.com/mnaoumov/obsidian-smart-rename.git synced 2026-07-22 07:40:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mnaoumov_obsidian-smart-rename/CONTRIBUTING.md
Michael Naumov 40666fe33f chore: update template
2026-06-09 06:41:09 -06:00

1,000 B
Raw Blame History

Contributing

Contributions are welcome! Here's how to get started.

Prerequisites

  • Node.js (latest LTS recommended)
  • npm (comes with Node.js)

Setup

git clone https://github.com/mnaoumov/obsidian-smart-rename.git
cd obsidian-smart-rename
npm install

Development Workflow

Build

npm run build

Dev Mode

npm run dev

Commit

This project uses Conventional Commits. Use the interactive commit prompt:

npm run commit

Lint

npm run lint
npm run lint:fix

Format

npm run format:check
npm run format

Spellcheck

npm run spellcheck

Test

npm run test
npm run test:coverage

Pull Requests

  • Base your PR on the master branch.
  • Ensure all checks pass (lint, format:check, spellcheck, test).
  • Use Conventional Commits for your commit messages.