Skip to content

Commit cc96f6b

Browse files
Readd build failure notes
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
1 parent 79f03af commit cc96f6b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -176,3 +176,15 @@ We have a lot of mechanisms to help expedite towards an accepted PR. Here are s
176176
7. *test, test, test*: pretty self explanatory ([OpenSearchTestCase](./test/framework/src/main/java/org/opensearch/test/OpenSearchTestCase.java) for unit tests, [OpenSearchIntegTestCase](./test/framework/src/main/java/org/opensearch/test/OpenSearchIntegTestCase.java) for integration & cluster tests, [OpenSearchRestTestCase](./test/framework/src/main/java/org/opensearch/test/rest/OpenSearchRestTestCase.java) for testing REST endpoint interfaces, and yaml tests with [ClientYamlTestSuiteIT](./rest-api-spec/src/yamlRestTest/java/org/opensearch/test/rest/ClientYamlTestSuiteIT.java) for REST integration tests)
177177

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

0 commit comments

Comments
 (0)