Skip to content

Commit 1b6fa6a

Browse files
authored
minor changes
1 parent 26d2fdd commit 1b6fa6a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/src/resources/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ 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 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:
75+
The changelog is written in the file `CHANGELOG.md` in the repository. If you add some changes to the repository and made a PR, you should also add some messages or release notes together with the related PRs/issues entries to `CHANGELOG.md`. For example, add a new line in `CHANGELOG.md`:
7676

7777
```markdown
7878
- some messages to describe the changes. ([#issue-ID], [#PR-ID])
@@ -89,6 +89,6 @@ After that, you can run the following command under the *__root directory of the
8989
make changelog
9090
```
9191

92-
This will automatically generate the full URLs for the references to PRs or issues by utilizing [`Changelog.jl`](https://github.com/JuliaDocs/Changelog.jl).
92+
This will automatically generate the full URLs for the references to PRs/issues by utilizing [`Changelog.jl`](https://github.com/JuliaDocs/Changelog.jl).
9393

9494
If the changes you made are not necessary to be recorded in `CHANGELOG.md`, you can add the label `[Skip ChangeLog]` to the PR you made in the GitHub repository.

0 commit comments

Comments
 (0)