Transmission/transmission
1
0
Fork 0
mirror of https://github.com/transmission/transmission.git synced 2026-02-15 07:26:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add PR release notes guidelines (#8320)

Browse Source 
* docs: add PR release notes guidelines

* fix: copypaste error
This commit is contained in:
Charles Kerr
2026-02-03 08:44:00 -06:00
committed by GitHub
parent 64a53a8219
commit b4c4047ab7
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -45,6 +45,23 @@ On macOS, Transmission is usually built with Xcode. Everywhere else, it's CMake
Note that Transmission existed in C for over a decade and those idioms don't change overnight. "Follow the C++ core guidelines" can be difficult when working with older code, and the maintainers will understand that when reviewing your PRs. :smiley: Note that Transmission existed in C for over a decade and those idioms don't change overnight. "Follow the C++ core guidelines" can be difficult when working with older code, and the maintainers will understand that when reviewing your PRs. :smiley:
## Pull Requests
When submitting a pull request, please add a one-sentence paragraph that begins with `Notes: ` for the release notes script.
- If this is a change that a user wouldn't care about -- say, a fix to a CI script -- use "Notes: none"
- If this is a change that affects users directly, describe the change in those terms:
- GOOD: "Notes: Added the ability to download torrents in sequential order."
- GOOD: "Notes: Fixed a crash when removing local data after a torrent completes."
- GOOD: "Notes: Improved performance when downloading from peers using µTP."
- If this is a change that doesn't affect users but is important to packagers, describe it in those terms.
- GOOD: "Notes: The Qt UI now requires Qt 5.15 or higher."
- GOOD: "Notes: Migrated from C++17 to C++20."
- Pay attention to your audience: these are release notes, not commit messages.
- BAD: "fix: crash in tr_swarmGetStats"
- BAD: "address minor clang warning"
- BAD: "Refactor: add libtransmission::Values."
## Considerations ## Considerations
- Prefer commonly-used tools over bespoke ones, e.g. use `std::list` instead of rolling your own list. This simplifies the code and makes it easier for other contributors to work with. - Prefer commonly-used tools over bespoke ones, e.g. use `std::list` instead of rolling your own list. This simplifies the code and makes it easier for other contributors to work with.