You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ Every public symbol is something that has to be kept in order to maintain backwa
82
82
83
83
To check if your PR is adding public symbols, run `tox -e public-symbols-check`. This will always fail if public symbols are being added/removed. The idea
84
84
behind this is that every PR that adds/removes public symbols fails in CI, forcing reviewers to check the symbols to make sure they are strictly necessary.
85
-
If after checking them, it is considered that they are indeed necessary, the PR will be labeled with `Skip Public API check` so that this check is not
85
+
If after checking them, it is considered that they are indeed necessary, the PR will be labeled with `Approve Public API check` so that this check is not
86
86
run.
87
87
88
88
Also, we try to keep our console output as clean as possible. Most of the time this means catching expected log messages in the test cases:
@@ -224,6 +224,23 @@ updating the GitHub workflow to reference a PR in the Contrib repo
224
224
* Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
225
225
* Urgent fix can take exception as long as it has been actively communicated.
226
226
227
+
#### Allow edits from maintainers
228
+
229
+
Something _very important_ is to allow edits from maintainers when opening a PR. This will
230
+
allow maintainers to rebase your PR against `main` which is necessary in order to merge
231
+
your PR. You could do it yourself too, but keep in mind that every time another PR gets
232
+
merged, your PR will require rebasing. Since only maintainers can merge your PR it is
233
+
almost impossible for maintainers to find your PR just when it has been rebased by you so
234
+
that it can be merged. Allowing maintainers to edit your PR also allows them to help you
235
+
get your PR merged by making any minor fixes to solve any issue that while being unrelated
236
+
to your PR, can still happen.
237
+
238
+
#### Fork from a personal Github account
239
+
240
+
Right now Github [does not allow](https://github.com/orgs/community/discussions/5634) PRs
241
+
to be edited by maintainers if the corresponding repo fork exists in a Github organization.
242
+
Please for this repo in a personal Github account instead.
243
+
227
244
One of the maintainers will merge the PR once it is **ready to merge**.
0 commit comments