Clarify and extend some of the PR and contribution guidelines so that
they cover practices that have been effectively enforced by maintainers,
but were never properly documented.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Minor rework to group linters together and to leave the list open in
case more linters are added overtime
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
There's no need for the CODEOWNERS file anymore as figuring out
maintainership and performing reviewer assignment is done via the
MAINTAINERS file now
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add an extra "git show" step to the release process to verify that the
key has been indeed signed.
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
Commit 52e8b1058c (doc: project: clarify
WG member eligibility) broke the link to the collaborator section by
using nested inline markup, which is currently not supported:
https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible
As the various workarounds are not recommended by Docutils, this change
simply ends the bold formatting before the link.
Signed-off-by: Reto Schneider <reto.schneider@husqvarnagroup.com>
Fixes bad usage of single backticks in lieu of double backticks for
rendering inline literals, or simple '*' for italics.
When appropriate, a better construct than double backticks has been
selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref:
have been used if the original intention was to have a link.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
There is no clear way for a candidate to assume the role of Maintainer
if the candidate is neither a Contributor nor a Collaborator. To avoid
disputes and confusion, candidates who are neither Contributors nor
Collaborators must be approved by the TSC before they can assume the
role of Maintainer.
Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
The project charter has apparently changed location on
the main zephyrproject.org website.
This fixes a couple occurences of the old URL.
fixes#76433
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
clarify membership eligibility and need to be a project collaborator,
add references and link to them.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
After RC1 (feature freeze), new tests for existing features are allowed.
Afterwards, only bug fixes and documentation to existing tests are
allowed.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
GitHub labels were hard to visually parse so use guilabel role to make them
stand out more, and put them in tabular format.
Other minor cosmetic tweaks
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
- Define TSC member role and add rights & responsibilities section.
- Document elected TSC member process
- Document working groups, membership and decision making processes in
TSC working groups.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Clarification of reviewer expectations and role. Emphasis
on clarifying when a PR can be closed.
Highlighting reviewers and assignee objective to guide PR
to a mergeable state, if possible.
Signed-off-by: David Leach <david.leach@nxp.com>
Utilize a code spell-checking tool to scan for and correct spelling errors
in all files within the doc/build, hardware, kernel, project directory.
Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
Sets static analysis an indispensable requirement for our project
releases.
Static analysis is not merely a tool but a proactive
strategy to unearth and address potential issues in the early stages
of development, long before they mature into critical
vulnerabilities. By scrutinizing code at rest, static analysis unveils
latent defects and potential security risks, thus bolstering the
resilience of our software against future threats.
Fixes: #64591
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
It is often confusing for users and developers alike to see the sentence
"stable API change" in a label or in the release notes. Stable APIs can
change in at least two ways (retaining compatibility or not), and so it
is preferrable to use a term that clearly describes the change as
incompatible, by using the common term "breaking".
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This adds a link for convenience. Many times before I struggled to
find the date for the next feature freeze. This is to help others,
and myself, to find it easier in the future.
Signed-off-by: Hein Wessels <heinwessels93@gmail.com>
Drop the notes about listing all the github issues with the release
notes. That was a huge list of github issues sorted by closing time,
very noisy and hard to maintain.
The unfiltered list of changes is already in the commit history, a
distilled list is now in the blog posts and a final list is in the notes
summary.
The issue list has been skipped in 3.4 already, let's just drop it from
the process.
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
prefix with numbers to get sorting based on usage. Most common files
issue types should come first, with bugs being at the top.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Rename topic branches to be collaboration branches, to avoid confusion
with common terminology of topic branches which serves a different
pupose.
Clarify collab branches and the need for TSC approval.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The RFC proposal documentation better belongs with the other
documentation related to contributing to the Zephyr project.
Signed-off-by: Keith Short <keithshort@google.com>
Collect up all the contributor expectations and PR requirements into a
single place. Add additional guidelines about creating small PRs and how
to break up PRs into multiple commits.
Signed-off-by: Keith Short <keithshort@google.com>
Be explicit that maintainers' decisions in their areas are final
unless overruled by the TSC.
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
At this point I think it's clear that discord is more important than
email as a discussion forum for the project, so clarify that on the
communication and collaboration page.
Email is still important, though (e.g. Discord is currently not
available in China) -- and we are not deprecating it at all.
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Now that the automation picks the right name automatically, there's no
need to edit it manually as part of the release process.
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
RC releases clutter the release page, there's no reason for keeping them
after the release is done, filter them out from the workflow so they
don't get created in the first place..
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
Drop the process step to create zephyr- prefixed tags.
This has been done so that autogenerated release files have a sensible
name, but GitHub started to automatically prefix the project names to
release artifacts anyway using HTTP headers, which now results in file
named like: zephyr-zephyr-v3.2.0.tar.gz, so the extra tags are now
causing the opposite problem.
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
Change the release process documentation to only use the overview of the
release notes for GitHub releases rather than the full file.
The current instructions of copying the full content are broken (the
file does not fit anyway and the formatting is incompatible) and result
in a cluttered page anyway (the UI is not really meant for long release
notes).
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
The paragraph that lists the mandatory labels (at least one of them must
be set, and at most one of those) was missing RFC.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This label has been removed, since we now convert issues that are just
questions to Discussions.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Move the sentence to the end of the section on labels applicable to
PRs only, reword it and convert to a note, indicating that the note
is for all labels in this section.
Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
Use full label names for examples in the description, and other minor
enhancements.
Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
