You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, we have EO snippets inside README.md, which are not checked for validity anyhow. Let's create a new GHA job, which will extract all snippets from the Markdown file, compile them and run.
The text was updated successfully, but these errors were encountered:
@yegor256 thanks for the report, here is a feedback:
Problems
The bug report's title lacks precision and descriptiveness. It needs to explicitly indicate the issue rather than the required action.
Essential details are missing in the bug report, including steps to reproduce the issue, the expected outcome, and the actual outcome.
The bug report fails to offer any error messages or logs, which could aid in better understanding the problem.
Suggestions
Title: Make the title more descriptive and precise. Instead of "validate snippets inside README.md", you might use "Issue with Unchecked EO Snippets in README.md".
Detailed Description: Start with a brief introduction of the problem, then provide more context. For instance, when and where does this issue typically occur? What is the impact of this issue?
Steps to Reproduce: Elaborate on the steps that led to the identification of this bug. For instance, which part of the code or process leads to the discovery of the unvalidated EO snippets?
Expected vs. Actual Results: Clearly state what the expected outcome should be and how the actual outcome differs. For example, were the EO snippets expected to be validated, but weren't?
Error Messages/Logs: Include any relevant error messages, logs, or screenshots that may help in understanding the problem better.
Context: Share any additional context or observations that could be helpful. For instance, does this problem occur consistently or intermittently?
Formatting: Ensure your report is well-formatted and easy to read. Lists, bullet points, and headers can greatly improve readability.
Language: Keep your language clear, concise, and professional. Avoid jargon and explain any abbreviations used.
Please fix the bug report in order it to get resolved faster.
Analyzed with gpt-4
Currently, we have EO snippets inside
README.md
, which are not checked for validity anyhow. Let's create a new GHA job, which will extract all snippets from the Markdown file, compile them and run.The text was updated successfully, but these errors were encountered: