obsidian-plugin/decaf-dev_obsidian-vault-explorer
1
0
Fork 0
mirror of https://github.com/decaf-dev/obsidian-vault-explorer.git synced 2026-07-22 10:10:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update CONTRIBUTING.md

Browse source
This commit is contained in:
DecafDev 2024-06-11 13:55:54 -06:00
parent 957514f06d
commit ed8d958f02
2 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -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.

4
README.md
View file

@ -103,9 +103,7 @@ ln -s <folder-path>/obsidian-vault-explorer/dist <vault-path>/.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