From ed8d958f023f2a246739f114a9af0a021a7bfb2f Mon Sep 17 00:00:00 2001 From: DecafDev <40307803+decaf-dev@users.noreply.github.com> Date: Tue, 11 Jun 2024 13:55:54 -0600 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++++++++-- README.md | 4 +--- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa35746..60ce938 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,18 @@ # Contribute to Vault Explorer -## Installation +Thank you for considering contributing to Vault Explorer! + +## Testing + +If you find a bug, please open an issue for it. If there's functionality that is annoying or you think that the UI can be improved, please open an issue for that as well. All feedback goes into making the plugin better. + +## Features + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +To get started with development, follow the guide below: + +### Installation Clone the repository @@ -52,7 +64,7 @@ Find **Vault Explorer** and then enable the plugin by switching the toggle. > [!NOTE] > You may need to click the **Reload plugins** button -## Development +### Development Checkout the `dev` branch and make a child branch off of it. diff --git a/README.md b/README.md index 3f0e2be..6e9b75a 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,7 @@ ln -s /obsidian-vault-explorer/dist /.obsidian/plugins/ ## Contributing -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. - -For detailed information on contributing see our [CONTRIBUTING.md](CONTRIBUTING.md) +For information on how to contribute to Vault Explorer, check out [CONTRIBUTING.md](CONTRIBUTING.md). ## Support