diff --git a/README.md b/README.md index e13a16c..e883dbc 100644 --- a/README.md +++ b/README.md @@ -25,5 +25,49 @@ This plugin can now be installed inside obsidian in the community plugins tab. [ # Usage Using Advanced merge is very easy! Just right click a folder and select `merge folder`. +# Contributing +To build and test this repository it is adviced 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 contribuitons are welcome, but before making anything big please concider starting a discussion in the issues tab. + +# Code of conduct +- Make sure your code is formatted. +- 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 comform to this format: +``` +
+ + +``` +## Commit Header +The type field is always required. Summary is optional when bumping version. Every commit should only contain one type. +``` +: + │ │ + │ └─⫸ Summary in present tense. Not capitalized. No period at the end. + │ + │ + └─⫸ Commit Type: build|docs|feat|fix|perf|refactor|test +``` +### Type +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 + + # Support You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)! \ No newline at end of file