Improve CONTRIBUTING.md: Add clear troubleshooting for flaky tests and update contributor guidelines#19748
Closed
akshith30388 wants to merge 5 commits intoopensearch-project:mainfrom
Closed
Conversation
:wq Signed-off-by: akshith30388 <akshithpola36@gmail.com> :wq Signed-off-by: akshith30388 <akshithpola36@gmail.com>
…etter contributor guidance Signed-off-by: akshith30388 <akshithpola36@gmail.com>
akshith30388
force-pushed
the
improve-contributing-md
branch
from
bf62b63 to
41d75b0
Compare
Author
|
“Hi maintainers, my gradle-check was cancelled by the workflow. Could you please re-approve or re-run the checks? All my commits are signed off and other checks have passed. Thank you!” |
Contributor
|
❌ Gradle check result for 41d75b0: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
Member
|
Thanks for contributing @akshith30388! However, I'm not sure this PR is ready. It looks like it deletes most of the content from CONTRIBUTING.md, breaks the table of contents in README.md, and creates an extra file. Can you take another look? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR enhances the CONTRIBUTING.md file by:
Adding detailed, step-by-step guidance for diagnosing, reporting, and resolving flaky tests, making the troubleshooting process more accessible for new contributors.
Clarifying instructions on opening issues, submitting work, and understanding changelog requirements.
Improving formatting for readability and ease of navigation.
These updates are aimed at supporting new and existing contributors and making it easier to maintain high project quality.
I have double-checked for Markdown correctness and ensured all guidance is practical and actionable. Feedback is very welcome!