alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
0fe78ed468
esp-idf/.gitlab/merge_request_templates/Mixed Template.md
Tomas Sebestik e4f3ba1365
ci: update Mixed Template, Release notes header
2023-11-29 10:03:33 +01:00

4.3 KiB
Raw Blame History

All texts in italics are instructional and should be replaced by contents or removed.

Checklist

This entire section can be deleted if all items are checked.

  • Enough information to help reviewers understand the issue, its root cause, impact, and the proposed solution
  • Enough information to help reviewers understand the feature, its functional description, example, documentation, test cases, test results, feature TODO list
  • The MR Title describes the change, including the component name, ie "lwip: Add support for IP over Pigeon"
  • All related links, including JIRA, backport, submodule MR, are mentioned in the Related subsection.
  • Any GitHub issues are linked inside the git commit message and corresponding release notes
  • Add label for the area this MR is part of
  • For documentation updates, check if label Docs and needs translation:CN or needs translation:EN have been added when the other language version still needs the update. Skip adding the label if the document is not yet translated.
  • Check if documents requiring translation fall under get-started section. If yes, add the labels mentioned above. Then the documentation team will assign a translator for you. Please inform the translator to prepare translation once your MR is ready to merge. The translation should be included in your MR to get it merged. For more information, see documentation workflow in Wiki.
  • Any necessary "needs backport" labels are added
  • Check if this is a breaking change. If it is, add notes to the Breaking change notes subsection below
  • Release note entry if this is a new public feature, or a fix for an issue introduced in the previous release.
  • The commit log is clean and ready to merge.
  • All relevant CI jobs have been run, i.e. jobs which cover the code changed by the MR.

For issues, put enough information here to help reviewers understand the issue, its root cause, impact, and the proposed solution.

If this issue is a regression, specify in the Related subsection below, in which commit or MR it was introduced. This helps reviewers to check if the backport labels are set correctly.

For features, put enough information here to help reviewers understand the feature, its functional description, example, documentation, test cases, test results, feature TODO list.

For other small/non-public changes, which are not expected to be in the release notes, can be mentioned here, include:

  • changes that don't apply to customers, e.g. some CI fixes, test only MR and etc

Related

  • Mention or related JIRA tasks (e.g. IDF-0000), to make sure they get updated.
  • Mention submodule MR, if there is
  • Mention backport(ed) MR, if there is

Don't touch the subsection titles below, they will be parsed by scripts.

Release notes

Changes made in this MR that should go into the Release Notes should be listed here. Please use past tense and specify the area (see maintainers page of IDF internal wiki). If there is a subscope, include it and separate with slash (/). Minor changes can go to the descriptions above without a release notes entry.

Write all the changes in a list (Start at the beginning of the line with - or *). If multiple changes are made, each of them should take a single line. If there is only one change to list, it should still be the only line of a list. If this MR does not need any release notes, write "No release notes" here without the - or *. e.g.

Breaking change notes

Remove this subsection if not used.

If there are any breaking changes, please mention it here. Talking about (1) what is not accepted any more, (2) the alternative solution and (3) the benefits/reason. e.g.

Please strictly follow the breaking change restriction, which means, if there is a breaking change but you are merging to non-major versions, you have to separate the breaking part out to another MR for a major version. The breaking change subsection is only accepted in MRs merging to major versions.

  • [VFS/UART] Now vfs_uart_set_rts_cts accept one more instance argument, to support configuration to different ports.