Skip to content

Commit f26f952

Browse files
committed
remove subsubsections in CHANGELOG.md
1 parent fa7fda0 commit f26f952

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

CHANGELOG.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,17 @@ All notable changes to [`QuantumToolbox.jl`](https://github.com/qutip/QuantumToo
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
<!-- some templates
9-
10-
## [vA.B.C] (YYYY-MM-DD) // New version tag and release date
11-
12-
### Added // new features or functionalities
13-
### Changed // some changes
14-
### Fixed // bug fix
15-
### Breaking // some functionalities that are no longer supported
16-
### Deprecated // deprecating some functionalities
17-
### Version changes // change version numbers of [compat] in Project.toml
18-
### Miscellaneous // other changes
8+
## Unreleased
199

20-
- some release notes. ([#PR-ID-1], [#PR-ID-2], ...)
10+
- *__We will start to write changelog once we have the first standard release.__*
2111

22-
-->
12+
## [v0.21.4] (2024-11-13)
2313

24-
## Unreleased
14+
- This is just a demonstration about [`Changelog.jl`](https://github.com/JuliaDocs/Changelog.jl). ([#139], [#306])
2515

26-
(We will start to write change log once we have the first standard release)
2716

2817
<!-- Links generated by Changelog.jl -->
2918

19+
[v0.21.4]: https://github.com/qutip/QuantumToolbox.jl/releases/tag/v0.21.4
20+
[#139]: https://github.com/qutip/QuantumToolbox.jl/issues/139
21+
[#306]: https://github.com/qutip/QuantumToolbox.jl/issues/306

docs/src/resources/contributing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,15 @@ This will start a local Vitepress site of documentation at `http://localhost:517
7272

7373
## [Update ChangeLog](@id doc-Contribute:Update-ChangeLog)
7474

75-
The changelog is recorded in the file `CHANGELOG.md` in the repository. If you add some changes to the package and made a PR, you should also add some messages or release notes together with the related PRs or issues entries to `CHANGELOG.md`. After that, you can run the following command under the *__root directory of the repository__* you are working on:
75+
The changelog is written in the file `CHANGELOG.md` in the repository. If you add some changes to the package and made a PR, you should also add some messages or release notes together with the related PRs or issues entries to `CHANGELOG.md`, for example:
76+
77+
```markdown
78+
- some messages to describe the changes. ([#issue-ID], [#PR-ID])
79+
```
80+
81+
See also the [Change Log page](@ref Change-Log) for more examples.
82+
83+
After that, you can run the following command under the *__root directory of the repository__* you are working on:
7684

7785
!!! note "Requirements"
7886
If this is your first time running `make` command in the local repository you are working on or you just had reinstalled `Julia`, you should run `make setup` first.

0 commit comments

Comments
 (0)