This document is a guide for people who want to contribute to the project.
- Node.js (v16 or later)
- Obsidian.md (v1.1.0 or later)
- Fork this repository
- Clone your fork into a local Obsidian Vault's
.obsidian/plugins
directory cd
intoobisidan-ai-research-assistant
- Create a new branch for your changes with the
feature/*
prefix (Example:feature/my-new-feature
) - Run
npm install
- Run
npm run dev
to start the development server - Make your changes locally
- Test your changes
- Commit your changes to your branch
- Push your changes to your fork
- Create a Pull Request
against the
main
branch of this repository
Note: During development, it is recommended to have a separate Obsidian vault for testing the plugin, and to also install the Obsidian Hot Reload plugin to automatically reload the plugin when you make changes.
- Run
npm run build
to build the plugin - The built files can be found in
/dist
This project uses the following tools, standards, and conventions to enforce code style, formatting, etc.:
- TypeScript
- husky
pre-commit
:lint-staged
commit-msg
:commitlint
Note: You can use the @commitlint/prompt-cli
via npx commit
if you want help formatting your commit messages properly.
Releases are automatically generated via semantic-release
when code is pushed to main