tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-09-16 06:26:27 +02:00
Code Issues Projects Releases Wiki Activity
afb8465d05
silverstripe-framework/docs/en/misc/contributing/issues.md

48 lines
3.6 KiB
Markdown
Raw Normal View History

Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md.
2012-10-09 01:32:22 +02:00
# Contributing Issues and Opinions
[« Back to Contributing page](../contributing)
## 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!
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
Our bugtracker is located on [open.silverstripe.org](http://open.silverstripe.org/).
Before submitting a bug:
* Ask for assistance on the [forums](http://silverstripe.org/forums), [core mailinglist](http://groups.google.com/group/silverstripe-dev) or on [IRC](http://silverstripe.org/irc) if you're unsure if its really a bug.
* [Search for existing tickets](http://open.silverstripe.org/query?keywords=~&description=~&summary=~&col=id&col=summary&col=owner&col=type&col=status&col=priority&col=milestone&col=changetime&desc=1&order=changetime) before reporting a new one
* 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](http://www.silverstripe.org/modules))
* Try to reproduce your issue on a [clean installation](http://doc.silverstripe.org/framework/en/installation/composer#using-development-versions), 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](http://open.silverstripe.org/newticket)
* Describe the steps required to reproduce your issue, and the expected outcome. Unit tests and screencasts can help here.
* Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.
* Add keywords to help us organize issues, and please be realistic about the issue priority. Don't set milestones.
* *(optional)* [Submit a pull request](/misc/contributing/code) which fixes the issue.
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md.
2012-10-09 01:32:22 +02:00
More docs on CMS issue reporting
2013-01-22 15:10:50 +01:00
Ensure you give us enough information to diagnose your issue:
* Switch your site to "[dev mode](http://doc.silverstripe.org/framework/en/topics/debugging)". 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](https://developers.google.com/chrome-developer-tools/docs/overview) or [Firefox dev tools](https://developer.mozilla.org/en-US/docs/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.
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md.
2012-10-09 01:32:22 +02:00
## Reporting Security Issues
Report security issues to [security@silverstripe.com](mailto:security@silverstripe.com). See our "[Release Process](release-process)" documentation for more info, and read our guide on [how to write secure code](/topics/security).
## Sharing your Opinion
* [silverstripe.org/forums](http://silverstripe.org/forums): Forums on silverstripe.org
* [silverstripe-dev](http://groups.google.com/group/silverstripe-dev): Core development mailinglist
* [silverstripe-documentation](http://groups.google.com/group/silverstripe-documentation): Documentation team mailing list
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
* [silverstripe-documentation](http://groups.google.com/group/silverstripe-translators): Translation team mailing list
Reference in New Issue Copy Permalink