Skip to content

Commit

Permalink
Update CHANGELOG and CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh committed Jul 15, 2023
1 parent e2f37f0 commit 677c7ba
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
5 changes: 4 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 7 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 677c7ba

Please sign in to comment.