Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (51 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 1.91 KB

Contributing to Themed Obsidian Discord RPC

Thanks for taking the time to contribute to Themed Obsidian Discord RPC 🎉

This project aims to provide a customizable and theme-aware Discord Rich Presence experience for Obsidian users. Contributions of all kinds are welcome.

Ways to Contribute

💡 Feature Requests

If you have an idea or improvement in mind just choose Requesting a feature on Issues

🧩 Code Contributions

Getting Started

  1. Fork the repository

  2. Clone your fork locally:

    git clone https://github.com/<your-username>/themed-obsidian-discord-rpc.git

  3. Create a new branch:

    git checkout -b feat/your-feature-name

Making Changes

  • Keep your changes focused and minimal
  • Follow the existing code structure and style

Commit Guidelines

Submitting a Pull Request

  1. Push your branch:

    git push origin feature/your-feature-name

  2. Open a Pull Request targeting the main branch

  3. Describe what you changed and why

  4. Link related issues if applicable

Testing & Building

Install dependencies

  1. you need to make sure you installed the required dependencies in order to test or build the plugin by running this command:
npm install
  1. in order to live test the plugin you just need to run:
npm run dev
  1. if you want to build the plugin just run:
npm run build

License

By contributing, you agree that your contributions will be licensed under the MIT Lisence this project.

Thank you for helping improve Themed Obsidian Discord RPC 🚀