Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.75 KB

CONTRIBUTING

REPORTING ISSUES

If you find a bug in osf.io or would like to propose a new feature, please file an issue report in CenterForOpenScience/osf.io. Below we have some information on how to best report the issue, but if you’re short on time or new to this, don’t worry! We really want to know about the problem, so go ahead and report it.

If you do this a lot, or you just want to know how to make it easier for us to find and fix the problem, keep reading.

Quick link

Submit an issue using that link and you will have a handy template to save you a little time in your issue reporting.

How to make the best issue

First, please make sure that the issue has not already been reported by searching through the issue archives.

When submitting an issue, be as descriptive as possible:

  • What you did (step by step)
    • Where does this happen on the OSF?
  • What you expected
  • What actually happened
    • Check the JavaScript console in the browser (e.g. In Chrome go to View → Developer → JavaScript console) and report errors
    • If it's an issue with staging, report whether or not it also occurs on production
    • If an error was generated, report what time it occurred, and the specific URL.
  • Potential causes
  • Suggest a solution
    • What will it look like when this issue is resolved?

Include pictures (e.g., in OSX press Cmd+Shift+4 to draw a box to screenshot)

Examples of good issue reporting: #382, #713.