Skip to content

Commit fc81a90

Browse files
Restore deleted section (opensearch-project#13415)
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
1 parent f84d28d commit fc81a90

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Changelog](#changelog)
1010
- [Review Process](#review-process)
1111
- [Tips for Success](#tips)
12+
- [Troubleshooting Failing Builds](#troubleshooting-failing-builds)
1213

1314
# Contributing to OpenSearch
1415

@@ -180,3 +181,13 @@ We have a lot of mechanisms to help expedite towards an accepted PR. Here are so
180181

181182
In general, adding more guardrails to your changes increases the likelihood of swift PR acceptance. We can always relax these guard rails in smaller followup PRs. Reverting a GA feature is much more difficult. Check out the [DEVELOPER_GUIDE](./DEVELOPER_GUIDE.md#submitting-changes) for more useful tips.
182183

184+
## Troubleshooting Failing Builds
185+
186+
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.
187+
188+
If your pull request reports a failing test(s) on one of the checks, please:
189+
- look if there is an existing [issue](https://github.com/opensearch-project/OpenSearch/issues) reported for the test in question
190+
- if not, please make sure this is not caused by your changes, run the failing test(s) locally for some time
191+
- 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
192+
- add a comment referencing the issue(s) or bug report(s) to your pull request explaining the failing build(s)
193+
- as a bonus point, try to contribute by fixing the flaky test(s)

0 commit comments

Comments
 (0)