adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: contribute: add a note about the GitHub "Update branch" feature

Browse source 
Add a note about the "branch out of date" and "Update branch" GitHub
feature. That message is confusing for new users and we often see people
losing approvals and introducing merge commits with it. Adding a note
in the contribution guidelines would hopefully help some.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
This commit is contained in:
Fabio Baltieri 2022-12-19 17:10:04 +00:00 committed by Carles Cufí
parent f781788ece
commit 7a9b019f46
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/contribute/guidelines.rst
View file

@ -584,6 +584,13 @@ workflow here:
review. Email will be sent as review comments are made, or you can check
on your pull request at https://github.com/zephyrproject-rtos/zephyr/pulls.
.. note:: As more commits are merged upstream, the GitHub PR page will show
a ``This branch is out-of-date with the base branch`` message and a
``Update branch`` button on the PR page. That message should be ignored,
as the commits will be rebased as part of merging anyway, and triggering
a branch update from the GitHub UI will cause the PR approvals to be
dropped.
#. While you're waiting for your pull request to be accepted and merged, you
can create another branch to work on another issue. (Be sure to make your
new branch off of main and not the previous branch.)::