CONTRIBUTING.md

Contributor's Guide

This document is a guide for people who want to contribute to the project.

How to contribute

Prerequisites

• Node.js (v16 or later)
• Obsidian.md (v1.1.0 or later)

Getting Started

1. Fork this repository
2. Clone your fork into a local Obsidian Vault's .obsidian/plugins directory
3. cd into obisidan-ai-research-assistant
4. Create a new branch for your changes with the feature/* prefix (Example: feature/my-new-feature)
5. Run npm install
6. Run npm run dev to start the development server
7. Make your changes locally
8. Test your changes
9. Commit your changes to your branch
10. Push your changes to your fork
11. 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.

Building the plugin

1. Run npm run build to build the plugin
2. The built files can be found in /dist

Conventions

This project uses the following tools, standards, and conventions to enforce code style, formatting, etc.:

• TypeScript
• husky
  • pre-commit: lint-staged
    • ESLint
      • Standard with TypeScript
    • Prettier
    • yamllint
    • scriptlint
  • commit-msg: commitlint
    • Conventional Commits

Note: You can use the @commitlint/prompt-cli via npx commit if you want help formatting your commit messages properly.

Releasing New Versions

Releases are automatically generated via semantic-release when code is pushed to main