Lines Matching +full:stale +full:- +full:issue +full:- +full:label
1 .. _dev-environment-and-tools:
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
59 changes can change the label of a pull request by adding a comment justifying
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 -----------------
70 Any change that is a fix to an issue that blocks developers from doing their
82 Trivial changes are those that appear obvious enough and do not require maintainer or code-owner
86 - Documentation changes
87 - Configuration changes
88 - Minor Build System tweaks
89 - Minor optimization to code logic without changing the logic
90 - Test changes and fixes
91 - Sample modifications to support additional configuration or boards etc.
118 A Pull-Request should have an Assignee
121 - An assignee to a pull request should not be the same as the
122 author of the pull-request
123 - An assignee to a pull request is responsible for driving the
125 - An assignee is responsible for dismissing stale reviews and seeking reviews
127 - Pull requests should not be merged without an approval by the assignee.
135 - Hot fixes: Fixing CI issues, reverts, and system breakage
136 - Release related changes: Changing version file, applying tags and release
146 Any change requests (-1) on a pull request have to be justified. A reviewer
147 should avoid blocking a pull-request with no justification. If a reviewer feels
151 - Trivial -> Maintainer
152 - Assign Pull Request to yourself, this will mean that a pull request should
159 A pull-request shall be merged only with two positive reviews (approval). Beside
160 the person merging the pull-request (merging != approval), two additional
174 - The feedback or concerns were visibly addressed by the author
175 - The reviewer did not revisit the pull request after 2 week and multiple pings
177 - The review is unrelated to the code change or asking for unjustified
180 - Split the PR
181 - Can you fix this unrelated code that happens to appear in the diff
182 - Can you fix unrelated issues
183 - Etc.
185 Closing Stale Issues and Pull Requests
188 - The Pull requests and issues sections on Github are NOT discussion forums.
191 - In case of both issues and pull-requests the original poster needs to respond
192 to questions and provide clarifications regarding the issue or the change.
213 - Run ``checkpatch`` for code style issues (can vote -1 on errors; see note)
214 - Gitlint: Git commit style based on project requirements
215 - License Check: Check for conflicting licenses
216 - Run ``twister`` script
218 - Run kernel tests in QEMU (can vote -1 on errors)
219 - Build various samples for different boards (can vote -1 on errors)
221 - Verify documentation builds correctly.
230 .. code-block:: c
233 IOPCTL_Type *base = config->base;
241 Maintainers can override the -1 in cases where the CI infrastructure
251 daily and long-term work and contributions to the Zephyr project. We use
261 This saves us all time when searching, reduces the chances of the PR or issue
262 being forgotten, speeds up reviewing, avoids duplicate issue reports, etc.
269 .. list-table::
270 :header-rows: 1
272 * - Label
273 - Description
275 * - :guilabel:`priority: {high|medium|low}`
276 - To classify the impact and importance of a bug or
277 :ref:`feature <feature-tracking>`.
279 Note: Issue priorities are generally set or changed during the bug-triage or TSC
282 * - :guilabel:`Regression`
283 - Something, which was working, but does not anymore (bug subtype).
285 * - :guilabel:`Enhancement`
286 - Changes/Updates/Additions to existing :ref:`features <feature-tracking>`.
288 * - :guilabel:`Feature request`
289 - A request for a new :ref:`feature <feature-tracking>`.
291 * - :guilabel:`Feature`
292 - A :ref:`planned feature<feature-tracking>` with a milestone.
294 * - :guilabel:`Hardware Support`
295 - Covers porting an existing feature (including Zephyr itself) to new hardware.
297 * - :guilabel:`Duplicate`
298 - This issue is a duplicate of another issue (please specify).
300 * - :guilabel:`Good first issue`
301 - Good for a first time contributor to take.
303 * - :guilabel:`Release Notes`
304 - Issues that need to be mentioned in release notes as known issues with
307 Any issue must be classified and labeled as either *Bug*, *Enhancement*, *RFC*,
310 Tracking<feature-tracking>`.
315 The issue or PR describes a change to a stable API.
317 .. list-table::
318 :header-rows: 1
320 * - Label
321 - Description
323 * - :guilabel:`Hotfix`
324 - Fix for an issue blocking development.
326 * - :guilabel:`Trivial`
327 - Simple changes that can have shorter review time and be reviewed by anyone, i.e. typos,
328 straightforward one-liner bug fixes, etc.
330 * - :guilabel:`Maintainer`
331 - Maintainer review required.
333 * - :guilabel:`Security Review`
334 - To be reviewed by a security expert.
336 * - :guilabel:`DNM`
337 - This PR should not be merged (Do Not Merge). For work in progress, GitHub
340 * - :guilabel:`Needs review`
341 - The PR needs attention from the maintainers.
343 * - :guilabel:`Backport`
344 - The PR is a backport or should be backported.
346 * - :guilabel:`Licensing`
347 - The PR has licensing issues which require a licensing expert to review it.
350 For all labels applicable to PRs: Please note that the label, together with
358 .. list-table::
359 :header-rows: 1
361 * - Label
362 - Description
364 * - :guilabel:`area: {area-name}`
365 - Indicates Zephyr subsystems (e.g, :guilabel:`area: Kernel`, :guilabel:`area: I2C`,
368 …:guilabel:`area: Coding Style`, :guilabel:`area: MISRA-C`) affected by the bug or the pull request.
370 An area maintainer should be able to filter by an area label and find all issues
373 * - :guilabel:`platform: {platform-name}`
374 - An issue or PR which affects only a particular platform.
376 * - :guilabel:`dev-review`
377 - The issue is to be discussed in the following `dev-review`_ if time
380 ….. _`dev-review`: https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-G…
382 * - :guilabel:`TSC`
383 - TSC stands for Technical Steering Committee. The issue is to be discussed in the
386 ….. _`TSC meeting`: https://github.com/zephyrproject-rtos/zephyr/wiki/Technical-Steering-Committee-…
388 * - :guilabel:`Breaking API Change`
389 - The issue or PR describes a breaking change to a stable API. See additional information
392 * - :guilabel:`bug`
393 - The issue is a bug, or the PR is fixing a bug.
395 * - :guilabel:`Coverity`
396 - A Coverity detected issue or its fix.
398 * - :guilabel:`Waiting for response`
399 - The Zephyr developers are waiting for the submitter to respond to a question, or
400 address an issue.
402 * - :guilabel:`Blocked`
403 - Blocked by another PR or issue.
405 * - :guilabel:`Stale`
406 - An issue or a PR which seems abandoned, and requires attention by the author.
408 * - :guilabel:`In progress`
409 - For PRs: is work in progress and should not be merged yet. For issues: Is being
412 * - :guilabel:`RFC`
413 - The author would like input from the community. For a PR it should be considered
416 * - :guilabel:`LTS`
417 - Long term release branch related.
419 * - :guilabel:`EXT`
420 - Related to an external component.