pedrohti/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-11-05 11:33:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Permit snippets at /doc/release-notes-uniq-name.md

Browse Source
This commit is contained in:
MarcoFalke
2026-11-05 09:40:49 +01:00
parent 0e38ad26af
commit fa2003a239
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/developer-notes.md
+2 -2
View File
@@ -1298,8 +1298,8 @@ Release notes should be written for any PR that:
- changes an API or configuration model
- makes any other visible change to the end-user experience.
Release notes should be added to a PR-specific release note file at
`/doc/release-notes-<PR number>.md` to avoid conflicts between multiple PRs.
Release notes should be added to a uniquely named release note file, such as
`/doc/release-notes-remove-feature-foo.md`, to avoid conflicts between multiple PRs.
All `release-notes*` files are merged into a single `release-notes-<version>.md` file prior to the release.
## RPC interface guidelines
test/lint/test_runner/src/lint_docs.rs
+2 -2
View File
@@ -21,8 +21,8 @@ pub fn lint_doc_release_note_snippets() -> LintResult {
Err(r#"
Release note snippets and other docs must be put into the doc/ folder directly.
The doc/release-notes/ folder is for archived release notes of previous releases only. Snippets are
expected to follow the naming "/doc/release-notes-<PR number>.md".
The doc/release-notes/ folder is for archived release notes of previous releases only. Snippets must
be uniquely named and placed directly in the doc/ folder.
"#
.trim()
.to_string())