Skip to content

Commit 909bffa

Browse files
authored
Add note for branch names to contribution guide (#356)
1 parent a597e28 commit 909bffa

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs/developer_guide/contributor_guide/code_contribution.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,11 @@ In order to submit a component pull request, follow these steps:
212212
1. Push a branch that contains your code change to the repo that you've forked
213213
on GitHub repository.
214214

215+
- The CI that will be run on the PR branch will check that the branch name
216+
is not ``main`` or starts with ``release-``, please ensure that the branch
217+
containing your code changes does not include either of these names when
218+
pushing your changes to the repo that you have forked.
219+
215220
2. `Create a Pull Request
216221
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_.
217222
You will be prompted to fill out a pull request template which lists the

0 commit comments

Comments
 (0)