As a Sourcegraph teammate, you have the ability to report bugs in the product when you come across them. You may wonder if there is a specific way to do this and this is why this doc exists. This is a step-by-step guide on what is the correct way to submit a bug report.
The steps below assume that you have encountered a fault/an error that makes the product behave unexpectedly.
- Head to the issues GitHub page here.
- Click on
New Issue(the green button on the right hand side of the page).
- A template named
Bug Reportshould be the second option available to you. Go ahead and click on
- Give your report a
Title. There’s no standard way of doing this although the general rule-of-thumb is to give a brief summary of the problem.
- Please be as detailed as possible in your description of the problem by;
- Sharing what Sourcegraph version you are currently experiencing the problem on.
- Highlighting any additional platform information(if you’re hosting your own instance).
- Providing steps that could help someone else reproduce the issue that you’ve encountered. In here, please feel free to get creative as you’d like(add screenshots,gifs or blocks of code to describe errors etc).
- Lastly, share what the actual behavior vs the expected is.
- Finally, please go ahead and add the
buglabel on the right hand side of the page by clicking on the small gear on the
Labelssection and typing in bug. Also, if you know the team that owns the part of the product that you’ve experienced the problem in, please feel free to add the team name here as well.
- All done! Go ahead and submit!
##A quick note Please note that if you are submitting a bug report on behalf of a customer, keep the report as general as possible, purposely withholding any sensitive information that can directly(or indirectly)point to a customer.