Skip to content

Commit d54e08e

Browse files
Update Github pull request template to have a task for inspecting failing checks (#10751) (#10792)
* Update Github pull request template to have a task for inspecting failing checks * Add failing builds troubleshooting section to CONTRIBUTING.md * Address review comments --------- (cherry picked from commit ffe9371) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent cf26b03 commit d54e08e

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [ ] All tests pass
1010
- [ ] New functionality has been documented.
1111
- [ ] New functionality has javadoc added
12+
- [ ] Failing checks are inspected and point to the corresponding known issue(s) (See: [Troubleshooting Failing Builds](../blob/main/CONTRIBUTING.md#troubleshooting-failing-builds))
1213
- [ ] Commits are signed per the DCO using --signoff
1314
- [ ] Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog))
1415
- [ ] Public documentation issue/PR [created](https://github.com/opensearch-project/documentation-website/issues/new/choose)

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Developer Certificate of Origin](#developer-certificate-of-origin)
99
- [Changelog](#changelog)
1010
- [Review Process](#review-process)
11+
- [Troubleshooting Failing Builds](#troubleshooting-failing-builds)
1112

1213
# Contributing to OpenSearch
1314

@@ -162,3 +163,14 @@ During the PR process, expect that there will be some back-and-forth. Please try
162163
If we accept the PR, a [maintainer](MAINTAINERS.md) will merge your change and usually take care of backporting it to appropriate branches ourselves.
163164

164165
If we reject the PR, we will close the pull request with a comment explaining why. This decision isn't always final: if you feel we have misunderstood your intended change or otherwise think that we should reconsider then please continue the conversation with a comment on the PR and we'll do our best to address any further points you raise.
166+
167+
## Troubleshooting Failing Builds
168+
169+
The OpenSearch testing framework offers many capabilities but exhibits significant complexity (it does lot of randomization internally to cover as many edge cases and variations as possible). Unfortunately, this posses a challenge by making it harder to discover important issues/bugs in straightforward way and may lead to so called flaky tests - the tests which flip randomly from success to failure without any code changes.
170+
171+
If your pull request reports a failing test(s) on one of the checks, please:
172+
- look if there is an existing [issue](https://github.com/opensearch-project/OpenSearch/issues) reported for the test in question
173+
- if not, please make sure this is not caused by your changes, run the failing test(s) locally for some time
174+
- if you are sure the failure is not related, please open a new [bug](https://github.com/opensearch-project/OpenSearch/issues/new?assignees=&labels=bug%2C+untriaged&projects=&template=bug_template.md&title=%5BBUG%5D) with `flaky-test` label
175+
- add a comment referencing the issue(s) or bug report(s) to your pull request explaining the failing build(s)
176+
- as a bonus point, try to contribute by fixing the flaky test(s)

0 commit comments

Comments
 (0)