obsidian-plugin/antokeinanen_obsidian-advanced-merger
1
0
Fork 0
mirror of https://github.com/antokeinanen/obsidian-advanced-merger.git synced 2026-07-22 07:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add 'code of conduct' and 'cotribution' to readme

Browse source
This commit is contained in:
Anto Keinänen 2023-05-10 17:37:12 +03:00 committed by GitHub
parent c20bed71fc
commit 1381e6cfec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -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 `<your obsidian vault folder>/.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:
```
<header>
<BLANK LINE>
<body>
```
## Commit Header
The type field is always required. Summary is optional when bumping version. Every commit should only contain one type.
```
<type>: <short summary>
│ │
│ └─⫸ 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)!