Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for building source and minimum requirements/spec #3171

Open
wants to merge 1 commit into
base: 3.x
Choose a base branch
from

Conversation

Agorguy
Copy link

@Agorguy Agorguy commented Sep 8, 2023

Check List:

This PR resolves the Issue #3170

This PR aims to prevent potential flaky test scenarios that may occur for other users or contributors in their machines.

The main goal of our contribution is to educate developers and users about the importance of having a minimum requirement for stable test execution. By specifying the minimum required RAM and CPU in the README, we can avoid unexpected test failures caused by insufficient resources on developers' machines.

Including this information requires minimal effort, yet it can save developers from the frustration of debugging flaky test failures if their machines don't meet the recommended specifications.

I don't know if readme.md is the best place to add this information. Let me know if you think there is another more suitable location.

@scordio scordio added the status: waiting for feedback We need additional information before we can continue label Sep 8, 2023
@Agorguy Agorguy changed the title Update README.md Add documentation for building source and minimum requirements/spec Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for feedback We need additional information before we can continue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some Flaky tests
2 participants