How to report a bug or an error, or to ask for some technical help

[Dominic Mitchell]

When reporting a suspected bug to us, or another kind of error, or if you need help with something, here is the information you need to provide to us. You won't be able to provide the details for all of these but fill in as many as you can. Thanks!

1. The contact details for the person reporting the bug (or at least a proxy for them, so that we can request more details). That might be you or someone working on your behalf.
2. The user account you are logged in to when the problem occurred.
3. At what time the incident occurred. Both date and time ideally. If it happened several times, then all dates/times that were recorded, or a range.
4. What were you trying to do? As much detail and context as possible. Send a screenshot! Pictures help.
5. What happened, what error message was received? Provide the exact error message, don't paraphrase. A screenshot could be provided here.
6. Which area of the system did this happen in. Generally, in the UI/API/OAI, and ideally specifically: which URL were you on when it happened, or which URL were you trying to access?
7. Send copies of any data you sent to the system. For example, article XML files uploaded, or payloads send to the API, if available.
8. What had you expected to happen?
9. Was the problem repeatable? Did you try several times with the same result?
10. What environment are you in? Specifically browser, or if not in the browser then any useful information about your API client such as the user agent.

DO NOT send us your passwords or API keys. Thank you!

Any questions, reply here.

Thanks

Dom

DOAJ Operations Manager