LabRPS at 15:14, 24 August 2022

2022-08-24T15:14:38Z

← Older revision		Revision as of 08:14, 24 August 2022
Line 40:		Line 40:
	* '''NOTE #1''' To keep things organized please remember to link the forum thread URL into the ticket and the ticket number (as a link) in to the forum thread.		* '''NOTE #1''' To keep things organized please remember to link the forum thread URL into the ticket and the ticket number (as a link) in to the forum thread.
	* '''NOTE #2''' Keep in mind there are no guarantees that your wish will be fulfilled.		* '''NOTE #2''' Keep in mind there are no guarantees that your wish will be fulfilled.
	~~[[File:MantisBT-setting-Feature-Request.jpg\|thumb\|LabRPS Bugtracker report page - use the dropdown to correctly designate what the ticket is]]~~

	== Submitting patches ==		== Submitting patches ==

LabRPS: Created page with "{{Docnav |Third Party Tools |Bug Triage }} {{TOCright}} The [https://www.labrps.com/tracker LabRPS BugTracker] is the place toː report bugs, submit feature requests, patches, or request to merge your branch if you developed something using Git. The tracker is divided into 'sections', so please be specific and file your request in the appropriate subsection. In case of doubt, leave it in the "LabRPS" section. == Recommended Workf..."

2022-08-24T15:12:30Z

Created page with "{{Docnav |Third Party Tools |Bug Triage }} {{TOCright}} The [https://www.labrps.com/tracker LabRPS BugTracker] is the place toː report bugs, submit feature requests, patches, or request to merge your branch if you developed something using Git. The tracker is divided into 'sections', so please be specific and file your request in the appropriate subsection. In case of doubt, leave it in the "LabRPS" section. == Recommended Workf..."

New page

{{Docnav
|[[Third_Party_Tools|Third Party Tools]]
|[[Bug_Triage|Bug Triage]]
}}

{{TOCright}}

The [https://www.labrps.com/tracker LabRPS BugTracker] is the place toː report bugs, submit feature requests, patches, or request to merge your branch if you developed something using Git. The tracker is divided into 'sections', so please be specific and file your request in the appropriate subsection. In case of doubt, leave it in the "LabRPS" section.

== Recommended Workflow ==
[[File:Bugreport-workflow.png|center]]

As shown in the above flowchart, before creating tickets, please always first search the forums and bugtracker to discover if your issue is a known issue. This saves a lot of time/work for developers and volunteers that could be spending said time making LabRPS even more awesome.

== Reporting bugs ==

If you think you might have found a bug, you are welcome to report it as long as you have followed our step-by-step guidelinesː

* Make sure you're using the most up to date version of LabRPS. '''NOTEː''' your bug may be fixed in the Development (unstable) version. The average user runs the stable version of LabRPS.
* Make sure your bug is really a bug, that is, something that should be working but isn't. '''Make sure the same bug hasn't been reported before by first searching the bugtracker and forum'''.
** Rememberː if you aren't sure, please don't hesitate to explain your problem/bug in the [http://labrps.com/boards Help forum] and ask what to do.
** '''Note'''ː before posting to the forum please read the [https://labrps.com/boards Forum Guidelines].
* Describe as clearly as possible the problem, and how it can be reproduced. If we can not verify the bug, we might not be able to fix it.
** This means '''reporting in a clear, well-formatted, step-by-step fashion''' so even an amateur user could reproduce.
** Recommendedː '''Screenshots''' of the bug are also very helpful to include. Windows users: please do not attach screen captures in Word or PDF format. Use the Windows Snipping tool to save your capture as a PNG image.
** Recommendedː Even better, an '''Animated gif or Screencast''' would also increase the likelihood of reproducing the issue.
* '''Add an example LabRPS file''' (.rps file) so devs/testers can quickly reproduce the bug.
** File attachments are limited in size. If your *.rps file is too big to attach, you can use an online storage service (many are free like Google Drive, Microsoft OneDrive, Dropbox).
* Include all the information from the "Copy to Clipboard" button in the '''Help (menu) -> About LabRPS''' dialogue.
* Please file one separate report for each bug.

== Requesting features ==

If you want something to appear in LabRPS that is not implemented yet, <u>it is not a bug but a feature request</u>.

# '''IMPORTANTː''' Before requesting a potential Feature Request '''please be certain that you are the first one doing so by searching the forums and the bugtracker'''. If you have concluded that there are no pre-existing tickets/discussions the next step is toː
# Start a forum thread to discuss your feature request with the community via the [http://labrps.com/boards Open Discussion forum].
# Once the community agrees that this is a valid Feature, you then can open a ticket on the tracker (file it under ''feature request'' instead of ''bug'').
* '''NOTE #1''' To keep things organized please remember to link the forum thread URL into the ticket and the ticket number (as a link) in to the forum thread.
* '''NOTE #2''' Keep in mind there are no guarantees that your wish will be fulfilled.
[[File:MantisBT-setting-Feature-Request.jpg|thumb|LabRPS Bugtracker report page - use the dropdown to correctly designate what the ticket is]]

== Submitting patches ==

In case you have programmed a bug fix, an extension or something else that can be of public use in LabRPS, submit your patch as a "Pull Request" at [https://github.com/LabRPS/LabRPS GitHub].
# For a large, complex, or behavior-changing submission, open a forum thread in the [https://labrps.com/boards Developer subforum] to announce and discuss your patch. For small bugfixes this is not necessary.
# Submit your Pull Request (PR) to the [http://github.com/LabRPS/LabRPS LabRPS GitHub repo]. The PR submission message will be pre-filled with a checklist for you to follow to ensure that your submission has the best chance at speedy acceptance. If you haven't worked with {{incode|git}} before or are unfamiliar with submitting a PR to github, please read our introduction to [[Source_code_management|github]] wiki page.
# Be present for the discussion, both in the forum and in the GitHub pull request, so that your code can potentially be merged more effectively.

== Requesting merge ==

(Same guidelines as [https://wiki.labrps.com/Tracker#Submitting_patches Submiting patches])

If you have created a git branch containing changes that you would like to see merged into the LabRPS code, you can ask there to have your branch reviewed and merged if the LabRPS developers are OK with it. You must first publish your branch to a public git repository (github, gitlab, bitbucket, sourceforge etc...) and then give the URL of your branch in your merge request.

== Related ==
* [[Bug_Triage|Bug Triage]]
* [[Source_Code_Management|Source Code Management]]

{{Docnav
|[[Third_Party_Tools|Third Party Tools]]
|[[Bug_Triage|Bug Triage]]
}}

{{Userdocnavi}}
[[Category:Developer Documentation]]
[[Category:Administration]]

Tracker - Revision history

LabRPS at 15:14, 24 August 2022