From 677c7ba07812b3ccc5d73d259dc682e51460ac66 Mon Sep 17 00:00:00 2001 From: epwalsh Date: Sat, 15 Jul 2023 09:07:43 -0700 Subject: [PATCH] Update CHANGELOG and CONTRIBUTING guide --- .github/CONTRIBUTING.md | 5 ++++- CHANGELOG.md | 11 +++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1cf649237..7c35369c5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,10 @@ Thanks for considering contributing! Please read this document to learn the vari ## Keeping the CHANGELOG up-to-date -This project tries hard to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and we maintain a `CHANGELOG` with a format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). If your PR addresses a bug or makes any other substantial change, please be sure to add an entry under the "Unreleased" section at the top. +This project tries hard to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and we maintain a [`CHANGELOG`](https://github.com/epwalsh/obsidian.nvim/blob/main/CHANGELOG.md) with a format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +If your PR addresses a bug or makes any other substantial change, please be sure to add an entry under the "Unreleased" section at the top of `CHANGELOG.md`. +Entries should always be in the form of a list item under a level-3 header of either "Added", "Fixed", "Changed", or "Removed" for the most part. +If the corresponding level-3 header for your item does not already exist in the "Unreleased" section, you should add it. ## Formatting code diff --git a/CHANGELOG.md b/CHANGELOG.md index 19b45da9a..9d010f538 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased -### Changed +### Added - Allow user to supply an argument to `ObsidianTemplate` to select a template. -- Renamed `command.insert_template()` to `command.template()` and split the template insert script into a separate function `util.insert_template()`. -- Added `log_level` option to suspend notifications. -- Added `completion.new_notes_location` to specify where newly created notes are placed in completion. + +### Changed + +- Renamed Lua function `command.insert_template()` to `command.template()` and split the template insert script into a separate function `util.insert_template()`. +- Added `log_level` configuration option to suspend notifications. +- Added `completion.new_notes_location` configuration option to specify where newly created notes are placed in completion. ### Fixed