Skip to content

Commit

Permalink
docs(general): Fixed the page for Error Reporting, text was wrong
Browse files Browse the repository at this point in the history
  • Loading branch information
gurpreetsinghmatharoo committed Dec 6, 2024
1 parent 4ddc1df commit 3e3f93e
Showing 1 changed file with 4 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,12 @@ <h3 id="h">Report A Bug Window</h3>
<p>The <a href="../IDE_Navigation/Menus/The_Help_Menu.htm">Help</a> -&gt; <strong>Report a GameMaker Bug</strong> option will open a window where you can create a bug report from within the IDE. If you&#39;re not signed in, a message is shown to ask you to <strong>Sign In/Register</strong>. It&#39;s also possible to <strong>Continue Anonymously</strong>.<br />
<img class="center" src="../assets/Images/IDE_Input/Help_Menu_Report_Bug_Anonymous.png" style="cursor: nwse-resize;" />If you are using a <span data-keyref="GameMaker Name">GameMaker</span> account, it is recommended to connect your GitHub account to your GM account via the <a href="https://gamemaker.io/account/dashboard">GameMaker Account Dashboard</a>. This will ensure your submitted reports are tied to your account so you can post updates and receive notifications from our team.
</p>
<p><img class="center" src="../assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png" />In the <strong>Report a Bug</strong> window you fill in a <strong>Title</strong> and <strong>Description</strong> and optionally the <strong>Steps To Reproduce</strong> the issue as well as assign the <strong>Issue Category</strong>.</p>
<p>You also have the option to <b>Privately attach this project</b>, which is generally required for many kinds of bug reports. You can also attach additional files. Finally, you should set the issue <strong>Visibility</strong>, either <strong>Public</strong> or <strong>Private</strong> (which does not affect your attached project and files, which are always private and only accessible by <span data-keyref="GameMaker Name">GameMaker</span> staff).<br />
<br />
As mentioned in the window, you should first check the list of <a href="https://github.com/YoYoGames/GameMaker-Bugs/issues">Known Issues</a> before submitting. You also have the possibility to report a <a href="https://github.com/YoYoGames/GameMaker-Bugs/security/policy">security vulnerability</a>.
</p>
<p><img class="center" src="../assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png" />In the <strong>Report a Bug</strong> window you must fill the <strong>Title</strong> and <strong>Description</strong>. You should also enter <strong>Steps To Reproduce</strong> the issue however that is optional. You must assign an <strong>Issue Category</strong>.</p>
<p>You also have the option to <b>Privately attach this project</b>, which is generally required for many kinds of bug reports. You can also attach any additional files that may help your bug report.</p>
<p class="note"><span data-conref="../assets/snippets/Tag_note.hts"> </span> Any files attached via the Bug Reporter are uploaded privately, only accessible by the <span data-keyref="GameMaker Name">GameMaker</span> team, even when the bug is public.</p>
<p class="note"><span data-conref="../assets/snippets/Tag_tip.hts"> </span> If you forgot to attach your project or any additional files with this dialog, you can use the <strong>Upload a Bug/Ticket Sample</strong> option in the <a href="../IDE_Navigation/Menus/The_Help_Menu.htm">Help menu</a> to upload those files and get a link that you can add to your issue.</p>
<p>You can choose to include the current project by ticking the <strong>Include project</strong> checkbox. It is highly recommended that you provide a sample project that shows the issue as it provides important information to the <span data-keyref="GameMaker Name">GameMaker</span> team about your issue. A message will be shown asking to include the current package when you select a category related to the runner and the checkbox isn&#39;t ticked.<br />
<br />
Finally you can submit the report by clicking the <strong>Submit</strong> button.
</p>
<p>As mentioned in the window, you should first check the list of <a href="https://github.com/YoYoGames/GameMaker-Bugs/issues">Known Issues</a> before submitting. You also have the possibility to report a <a href="https://github.com/YoYoGames/GameMaker-Bugs/security/policy">security vulnerability</a>.</p>
<p>Finally you can submit the report by clicking the <strong>Submit</strong> button.</p>
<h3>Crash Detected Window</h3>
<p>In extreme cases where <span data-keyref="GameMaker Name">GameMaker</span> crashes entirely, you may see on your next startup that the IDE bug reporter tells you that an earlier crash was detected and it will ask you to send us a bug report. Please do this.</p>
<p><img alt="Crash Report Window" class="center" src="../assets/Images/Setup_And_Version/Getting_Started_Crash_Report.png" />Clicking on <strong>Report</strong> will open the <strong>Report a Bug</strong> window described above.</p>
Expand Down

0 comments on commit 3e3f93e

Please sign in to comment.