Re: Patch contribution tips

Erwan Gouriou

Hi Raùl,

Regarding the question about a way to run full non regression test, as mentioned by Jennifer, advice is to 
use dedicated tool called twister:

About the warnings reported by compliance checks, we can indeed argue these are of minor importance 
and could be derogated (especially in this case where effort was made to clearly document the change).
One reason not to derogate and do the requested change is that maintainers and release engineers (the 
ones who merge) bandwidth is limited,  so we're heavily relying on automated checks and verdicts. 
This allows using github filters to get a list of PRs that are fulfilling all merge criterias. For instance,
here is the filter reporting PRs ready for merge:
(At the time I'm writing these lines, 17 PRs waiting for merge > list is long).

So even if derogating rules with automated checks would make sense in some cases, this actually requires
time to deviate from the process (ping people, agree that in that particular case deviation is justified, ....).
And of course, the more derogations are done, the more derogations are requested.
So getting compliance checks happy saves time (and then that time could be better spent in other tasks).

Hope it helps.

On Tue, 23 Mar 2021 at 21:21, Jennifer M Williams <jennifer.m.williams@...> wrote:

Hi Raúl,


Thanks for your contribution! Welcome to the community. Please take a look at this information on the project docs Sounds like you would be interested in using Twister to run many of the tests the CI system runs.


I encourage others to reply as well, but I had a minute to drop in with something hoping to get you going.





From: devel@... <devel@...> On Behalf Of Raúl Sánchez Siles
Sent: Tuesday, March 23, 2021 12:06 PM
To: devel@...
Subject: [Zephyr-devel] Patch contribution tips




  I have dared to create my first contribution [1]. Unfortunately I think there are some missing bits I would need to figure out somewhere. I took a look at the documentation and did my best, but still some gaps are left to me to fill in.




  For this particular PR, the patch compliance check fails because I copied verbatim the error I tried to fix and some of the commit lines are longer than what is recommended and hence the check fails due to warnings. My first question is whether this kind of warnings are tolerated (for the PR to succeed) and if is there a way to hint the compliance checker to overlook such a case.


  For the above PR, I think the changes are simple enough but in case I happen to go with more intrusive changes I would like to know if there is a way to run the complete set of zephyr tests locally somehow. In other words the whole test set contained under the tests/ directory in the greatest possible extension, including all possible archs, boards, etc, ... (if this is possible at all). Perhaps you already do something like this automatically as part of the global CI pipeline.


  Lastly, if you have some more relevant tips about contribution I would like to read them.


  Best regards,



Raúl Sánchez Siles


SW Engineer



Join to automatically receive all group messages.