diff --git a/README.md b/README.md index e13a16c..598cd4d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Obsidian Advanced Merge -Merge a folder of notes for easier export. This plugin is designed for [obsidian](https://obsidian.md/) app. +Merge a folder of notes for easier export. This plugin is designed for the [obsidian](https://obsidian.md/) app. ![preview](https://github.com/antoKeinanen/obsidian-advanced-merger/blob/master/media/1%200Ghz5j7MB_oKJdxoIc5-lg.gif?raw=true)

@@ -9,9 +9,9 @@ Preview of the plugin. Image by # Installation ## Installation through Obsidian community marketplace -This plugin can now be installed inside obsidian in the community plugins tab. [Link](obsidian://show-plugin?id=advanced-merger) -1. Go to obsidian settings panel. -2. Open community plugins tab. +This plugin can now be installed inside Obsidian in the community plugins tab. [Link](obsidian://show-plugin?id=advanced-merger) +1. Go to the Obsidian settings panel. +2. Open the community plugins tab. 3. Browse community plugins. 4. Search `Advanced Merger`. 5. Install and enable the plugin. @@ -20,10 +20,60 @@ This plugin can now be installed inside obsidian in the community plugins tab. [ 1. Download the latest release from [releases page](https://github.com/antoKeinanen/obsidian-advanced-merger/releases). 2. Extract the zip archive. 3. Move the 2 files (`manifest.json`, and `main.js`) to `/.obsidian/plugins/obsidian-advanced-merger` -4. Start obsidian, go to settings>community plugins, and turn `Advanced merger` on. +4. Start Obsidian, go to settings>community plugins, and turn `Advanced merger` on. # Usage -Using Advanced merge is very easy! Just right click a folder and select `merge folder`. +Using Advanced merger is very easy! Just right-click a folder and select `merge folder`. + +# Contributing +To build and test this repository it is advised to create a new vault. Clone this repository to `/.obsidian/plugins/` and run `yarn install` and `yarn build` or `npm install` and `npm build` inside of is. Then in Obsidian toggle the plugin on and off to refresh it. + +All contributions are welcome, but before making anything big please consider starting a discussion in the issues tab. + +# Code of conduct +- Make sure your code is formatted with the `npm/yarn run format` script. +- Use angular commit message style. More info [here](https://github.com/antoKeinanen/obsidian-advanced-merger#commit-message-format). +## Commit message format +*This specification is inspired by and supersedes the [AngularJS commit message format.](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit)* + +This format leads to easier-to-read commit history. +All commit messages must conform to this format: +``` +

+ + +``` +## Commit Header +The type field is always required. A summary is optional when bumping the version. If the commit is related to issue please refer to it. Every commit should only contain one type. +``` +(): + │ │ + │ └─⫸ Summary in the present tense. Not capitalized. No period at the end. + │ + │ + └─⫸ Commit Type: build|docs|feat|fix|perf|refactor|test +``` +### Type +**Example**: `fix(#123): fix a bug where XYZ`, `bump-version`, `feat(#123): add a feature that XYZ` +Must be one of the following: +- build: Changes that affect the build system or external dependencies +- docs: Documentation only changes +- feat: A new feature +- fix: A bug fix +- refactor: A code change that neither fixes a bug nor adds a feature +- test: Adding new tests or correcting existing tests + +## Summary +Use the summary field to provide a succinct description of the change: +- use the imperative, present tense: "change" not "changed" nor "changes" +- don't capitalize the first letter +- no dot (.) at the end + +## Message body +- Optional but recommended +- Just as in use imperative, present tense: “change” not “changed” nor “changes” + + # Support You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)! \ No newline at end of file