tonyair
/
silverstripe-framework
mirror of https://github.com/silverstripe/silverstripe-framework
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
silverstripe-framework/docs/en/05_Contributing/00_Issues_and_Bugs.md

3.8 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 in our community channels if you're unsure if it's really a bug.
  • Search for similar, existing tickets. You can list all issues across modules, then add your search phrase at the start of the existing search filters (for example all issues with label "type/ux")
  • Is this a security issue? Please follow our separate reporting guidelines below.
  • Which modules does this issue belong to? Each one has its own issue tracker. If you are unsure, create an issue on the the "framework" repository. Note that documentation issues are tracked in "framework" as well.
  • 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 UserVoice and our community channels. 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 an issue on the right module repository in GitHub
  • 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.

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 way. 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](/contributing/code/#step-by-step-from-forking-to-sending-the-pull-request) 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 community channels.

Reporting Security Issues

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

Sharing your Opinion