Things to do when submitting a PR


Nashif, Anas
 

Hi,

Here is a TOP10 list to improve and accelerate the review process of pull requests. If you follow them, chances are your pull request will get the attention needed and it will be ready for merge sooner than later:

 

  1. Make sure you are on top of latest main branch
    1. # git fetch upstream
    2. # git rebase upstream/main
  2. Run compliance tests locally and fix any issues before submitting a PR
    1. # ./scripts/ci/check_compliance.py -c upstream/main..
  3. Make sure title of PR explains what is being fixed or added
  4. Make sure your PR has a body with more details about the content of your submission
  5. Make sure you reference the issue you are fixing in the body of the PR
  6. Add reviewers if you can and know who will be able to review your code
  7. Set the labels if those are not automatically set by the bot.
  8. Watch early CI results immediately after submissions and fix issues as they are discovered
  9. Revisit PR after 1-2 hours to see the status of all CI checks, make sure all is green
  10. If you get request for changes and submit a change to address them, make sure you re-request review from those who asked for the changes

 

Regards,

 

Anas


Glaropoulos, Ioannis
 

Thanks! Could this be (if not already) part of a “best-practices” section in our Contribution guidelines?

 

/Ioannis

 

From: devel@... <devel@...> On Behalf Of Nashif, Anas via lists.zephyrproject.org
Sent: Tuesday, June 1, 2021 2:49 PM
To: devel@...
Subject: [Zephyr-devel] Things to do when submitting a PR

 

Hi,

Here is a TOP10 list to improve and accelerate the review process of pull requests. If you follow them, chances are your pull request will get the attention needed and it will be ready for merge sooner than later:

 

  1. Make sure you are on top of latest main branch
    1. # git fetch upstream
    2. # git rebase upstream/main
  2. Run compliance tests locally and fix any issues before submitting a PR
    1. # ./scripts/ci/check_compliance.py -c upstream/main..
  3. Make sure title of PR explains what is being fixed or added
  4. Make sure your PR has a body with more details about the content of your submission
  5. Make sure you reference the issue you are fixing in the body of the PR
  6. Add reviewers if you can and know who will be able to review your code
  7. Set the labels if those are not automatically set by the bot.
  8. Watch early CI results immediately after submissions and fix issues as they are discovered
  9. Revisit PR after 1-2 hours to see the status of all CI checks, make sure all is green
  10. If you get request for changes and submit a change to address them, make sure you re-request review from those who asked for the changes

 

Regards,

 

Anas


Nicolas Pitre
 

On Tue, 1 Jun 2021, Nashif, Anas wrote:

2. Run compliance tests locally and fix any issues before submitting a PR
* # ./scripts/ci/check_compliance.py -c upstream/main..
Could such somewhat criptic commands be grouped into an easy to run and
remember ./scripts/pre-submit-validation script? Something that needs no
arguments and does the right thing out of the box.


Nicolas


Yasushi SHOJI
 

Hi,

On Tue, Jun 1, 2021 at 9:48 PM Nashif, Anas <anas.nashif@intel.com> wrote:
Add reviewers if you can and know who will be able to review your code
Can a regular contributor do this? Using a mention?
I'd love to fix scripts/get_maintainer.py in order to find who to ask.

Set the labels if those are not automatically set by the bot.
If you don't have write permission, you can't add any label, right?
--
yashi