Lines Matching +full:merge +full:- +full:commit
1 .. _dev-environment-and-tools:
9 GitHub is intended to provide a framework for reviewing every commit before it
26 release managers are allowed to merge a pull request into the main branch once
31 Give reviewers time to review before code merge
42 code-owner review. Additionally, some changes might require further discussions
50 :figclass: align-center
55 ---------
57 - An author of a change can suggest in his pull-request which category a change
61 - The project will use the label system to categorize the pull requests.
62 - Changes should not be merged before the minimal time has expired.
65 -----------------
78 Trivial changes are those that appear obvious enough and do not require maintainer or code-owner
82 - Documentation changes
83 - Configuration changes
84 - Minor Build System tweaks
85 - Minor optimization to code logic without changing the logic
86 - Test changes and fixes
87 - Sample modifications to support additional configuration or boards etc.
108 A Pull-Request should have an Assignee
111 - An assignee to a pull request should not be the same as the
112 author of the pull-request
113 - An assignee to a pull request is responsible for driving the
115 - An assignee is responsible for dismissing stale reviews and seeking reviews
117 - Pull requests should not be merged without an approval by the assignee.
125 - Hot fixes: Fixing CI issues, reverts, and system breakage
126 - Release related changes: Changing version file, applying tags and release
136 Any change requests (-1) on a pull request have to be justified. A reviewer
137 should avoid blocking a pull-request with no justification. If a reviewer feels
141 - Trivial -> Maintainer
142 - Assign Pull Request to yourself, this will mean that a pull request should
149 A pull-request shall be merged only with two positive reviews (approval). Beside
150 the person merging the pull-request (merging != approval), two additional
151 approvals are required to be able to merge a pull request. The person merging
152 the request can merge without approving or approve and merge to get to the 2
164 - The feedback or concerns were visibly addressed by the author
165 - The reviewer did not revisit the pull request after 2 week and multiple pings
167 - The review is unrelated to the code change or asking for unjustified
170 - Split the PR
171 - Can you fix this unrelated code that happens to appear in the diff
172 - Can you fix unrelated issues
173 - Etc.
178 - The Pull requests and issues sections on Github are NOT discussion forums.
181 - In case of both issues and pull-requests the original poster needs to respond
203 - Run ``checkpatch`` for code style issues (can vote -1 on errors; see note)
204 - Gitlint: Git commit style based on project requirements
205 - License Check: Check for conflicting licenses
206 - Run ``twister`` script
208 - Run kernel tests in QEMU (can vote -1 on errors)
209 - Build various samples for different boards (can vote -1 on errors)
211 - Verify documentation builds correctly.
220 .. code-block:: c
223 IOPCTL_Type *base = config->base;
231 Maintainers can override the -1 in cases where the CI infrastructure
241 daily and long-term work and contributions to the Zephyr project. We use
259 .. list-table::
260 :header-rows: 1
262 * - Label
263 - Description
265 * - :guilabel:`priority: {high|medium|low}`
266 - To classify the impact and importance of a bug or
267 :ref:`feature <feature-tracking>`.
269 Note: Issue priorities are generally set or changed during the bug-triage or TSC
272 * - :guilabel:`Regression`
273 - Something, which was working, but does not anymore (bug subtype).
275 * - :guilabel:`Enhancement`
276 - Changes/Updates/Additions to existing :ref:`features <feature-tracking>`.
278 * - :guilabel:`Feature request`
279 - A request for a new :ref:`feature <feature-tracking>`.
281 * - :guilabel:`Feature`
282 - A :ref:`planned feature<feature-tracking>` with a milestone.
284 * - :guilabel:`Hardware Support`
285 - Covers porting an existing feature (including Zephyr itself) to new hardware.
287 * - :guilabel:`Duplicate`
288 - This issue is a duplicate of another issue (please specify).
290 * - :guilabel:`Good first issue`
291 - Good for a first time contributor to take.
293 * - :guilabel:`Release Notes`
294 - Issues that need to be mentioned in release notes as known issues with
300 Tracking<feature-tracking>`.
307 .. list-table::
308 :header-rows: 1
310 * - Label
311 - Description
313 * - :guilabel:`Hotfix`
314 - Fix for an issue blocking development.
316 * - :guilabel:`Trivial`
317 - Simple changes that can have shorter review time and be reviewed by anyone, i.e. typos,
318 straightforward one-liner bug fixes, etc.
320 * - :guilabel:`Maintainer`
321 - Maintainer review required.
323 * - :guilabel:`Security Review`
324 - To be reviewed by a security expert.
326 * - :guilabel:`DNM`
327 - This PR should not be merged (Do Not Merge). For work in progress, GitHub
330 * - :guilabel:`Needs review`
331 - The PR needs attention from the maintainers.
333 * - :guilabel:`Backport`
334 - The PR is a backport or should be backported.
336 * - :guilabel:`Licensing`
337 - The PR has licensing issues which require a licensing expert to review it.
341 PR complexity, affects how long a merge should be held to ensure proper
348 .. list-table::
349 :header-rows: 1
351 * - Label
352 - Description
354 * - :guilabel:`area: {area-name}`
355 - Indicates Zephyr subsystems (e.g, :guilabel:`area: Kernel`, :guilabel:`area: I2C`,
358 …:guilabel:`area: Coding Style`, :guilabel:`area: MISRA-C`) affected by the bug or the pull request.
363 * - :guilabel:`platform: {platform-name}`
364 - An issue or PR which affects only a particular platform.
366 * - :guilabel:`dev-review`
367 - The issue is to be discussed in the following `dev-review`_ if time
370 ….. _`dev-review`: https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-G…
372 * - :guilabel:`TSC`
373 - TSC stands for Technical Steering Committee. The issue is to be discussed in the
376 ….. _`TSC meeting`: https://github.com/zephyrproject-rtos/zephyr/wiki/Technical-Steering-Committee-…
378 * - :guilabel:`Breaking API Change`
379 - The issue or PR describes a breaking change to a stable API. See additional information
382 * - :guilabel:`bug`
383 - The issue is a bug, or the PR is fixing a bug.
385 * - :guilabel:`Coverity`
386 - A Coverity detected issue or its fix.
388 * - :guilabel:`Waiting for response`
389 - The Zephyr developers are waiting for the submitter to respond to a question, or
392 * - :guilabel:`Blocked`
393 - Blocked by another PR or issue.
395 * - :guilabel:`Stale`
396 - An issue or a PR which seems abandoned, and requires attention by the author.
398 * - :guilabel:`In progress`
399 - For PRs: is work in progress and should not be merged yet. For issues: Is being
402 * - :guilabel:`RFC`
403 - The author would like input from the community. For a PR it should be considered
406 * - :guilabel:`LTS`
407 - Long term release branch related.
409 * - :guilabel:`EXT`
410 - Related to an external component.