tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity
b4d8dfc9ee
silverstripe-framework/docs/en/05_Contributing/00_Issues_and_Bugs.md
Will Rossiter f633236e78 Review and tidy up contributing documentation.
2014-12-17 15:48:57 +13:00

4.5 KiB
Raw Blame History

title: Bug Reports summary: Report bugs or problems with SilverStripe, feature requests or other issues.

Contributing Issues and Opinions

Reporting Bugs

If you have discovered a bug in SilverStripe, we'd be glad to hear about it - well written bug reports can be half of the solution already!

Before submitting a bug:

  • Ask for assistance on the forums, core mailinglist or on IRC if you're unsure if its really a bug.
  • Search for similar, existing tickets
  • Is this a security issue? Please follow our separate reporting guidelines below.
  • Is this a issue with the core framework or cms? Modules have their own issue trackers (see silverstripe.org/modules)
  • Try to reproduce your issue on a clean installation, maybe the bug has already been fixed on an unreleased branch?
  • The bugtracker is not the place to discuss enhancements, please use the forums or mailinglist. Only log enhancement tickets if they gather a large interest in the community and the enhancement is likely to be implemented in the next couple of months.

If the issue does look like a new bug:

  • Create a new ticket
  • Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
  • Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.
  • (optional) Submit a pull request which fixes the issue.

Ensure you give us enough information to diagnose your issue:

  • Switch your site to "dev mode". Paste any PHP errors with their stacktraces. A generic "Server Error" message is not enough information.
  • If you suspect a JavaScript or CSS bug, check if it appears in other browsers
  • Use the Chrome dev tools or Firefox dev tools
  • Use the JavaScript console in your browser to determine if any errors happened there, and paste the complete info into issue description.
  • Use the "Network" panel to determine if any XHR ("Ajax") requests have returned errors, and paste the HTTP headers as well as HTTP response body into the issue description.

Lastly, don't get your hopes up too high. Unless your issue is a blocker affecting a large number of users, don't expect SilverStripe developers to jump onto it right away. Your issue is a starting point where others with the same problem can collaborate with you to develop a fix.

Feature Requests

Please don't file "feature requests" as Github issues. If there's a new feature you'd like to see in SilverStripe, you either need to write it yourself (and [submit a pull request](/misc/contributing/code)) or convince somebody else to write it for you. Any "wishlist" type issues without code attached can be expected to be closed as soon as they're reviewed.

In order to gain interest and feedback in your feature, we encourage you to present it to the community through the forums, core mailinglist or on IRC.

Reporting Security Issues

Report security issues to security@silverstripe.com. See our "Release Process" documentation for more info, and read our guide on how to write secure code.

Sharing your Opinion