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
2d4cbf8fef
silverstripe-framework/docs/en/05_Contributing/00_Issues_and_Bugs.md

62 lines
3.8 KiB
Markdown
Raw Normal View History

Review and tidy up contributing documentation.
2014-09-26 09:49:44 +02:00
title: Bug Reports
summary: Report bugs or problems with SilverStripe, feature requests or other issues.
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
## 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!
Contribution guidelines, new bugtracker links
2013-04-02 01:46:36 +02:00
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
Before submitting a bug:
Remove module-specific docs instructions We have too many docs to list these out now, even in 3.x this was a bit of a stopgap solution. Point to a centrally managed URL on silverstripe.org instead, where we can update the list of "core modules" regularly without breaking URLs in the docs etc Note that these URLs are also used internally by the Open Sourcerers team.
2018-01-29 03:38:04 +01:00
* Ask for assistance in our [community channels](https://www.silverstripe.org/community) if you're unsure if it's really a bug.
* Search for similar, existing tickets.
You can [list all issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues),
Closing bracket
2018-02-13 22:14:44 +01:00
then add your search phrase at the start of the existing search filters (for example [all issues with label "type/ux"](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-open-ux-issues))
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
* Is this a security issue? Please follow our separate reporting guidelines below.
Remove module-specific docs instructions We have too many docs to list these out now, even in 3.x this was a bit of a stopgap solution. Point to a centrally managed URL on silverstripe.org instead, where we can update the list of "core modules" regularly without breaking URLs in the docs etc Note that these URLs are also used internally by the Open Sourcerers team.
2018-01-29 03:38:04 +01:00
* Which modules does this issue belong to? Each one has its own issue tracker.
If you are unsure, [create an issue](https://github.com/silverstripe/silverstripe-framework/issues/new) on the the "framework" repository.
Note that [documentation issues](https://github.com/silverstripe/silverstripe-framework/issues) are tracked in "framework" as well.
DOCS Fixed link on issues and bugs
2015-02-06 08:37:50 +01:00
* Try to reproduce your issue on a [clean installation](/getting_started/composer#using-development-versions), maybe the bug has already been fixed on an unreleased branch?
Remove module-specific docs instructions We have too many docs to list these out now, even in 3.x this was a bit of a stopgap solution. Point to a centrally managed URL on silverstripe.org instead, where we can update the list of "core modules" regularly without breaking URLs in the docs etc Note that these URLs are also used internally by the Open Sourcerers team.
2018-01-29 03:38:04 +01:00
* The bugtracker is not the place to discuss enhancements, please use
DOCS Remove uservoice mentions See https://forum.silverstripe.org/t/a-new-way-to-manage-feature-ideas/2264
2019-09-06 06:01:30 +02:00
the ["feature ideas" forum category](https://forum.silverstripe.org/c/feature-ideas) and our [community channels](https://www.silverstripe.org/community).
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
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:
Remove module-specific docs instructions We have too many docs to list these out now, even in 3.x this was a bit of a stopgap solution. Point to a centrally managed URL on silverstripe.org instead, where we can update the list of "core modules" regularly without breaking URLs in the docs etc Note that these URLs are also used internally by the Open Sourcerers team.
2018-01-29 03:38:04 +01:00
* Create an issue on the right module repository in GitHub
Contribution guidelines, new bugtracker links
2013-04-02 01:46:36 +02:00
* Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
Updated issue reporting guidelines
2013-01-22 11:53:55 +01:00
* Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.
DOCS Fixed link on issues and bugs
2015-02-06 08:37:50 +01:00
* *(optional)* [Submit a pull request](/contributing/code/#step-by-step-from-forking-to-sending-the-pull-request) 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
Review and tidy up contributing documentation.
2014-09-26 09:49:44 +02:00
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.
Contribution guidelines, new bugtracker links
2013-04-02 01:46:36 +02:00
## Feature Requests
<div class="warning" markdown='1'>
Review and tidy up contributing documentation.
2014-09-26 09:49:44 +02:00
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
DOCS Fixed link on issues and bugs
2015-02-06 08:37:50 +01:00
[submit a pull request](/contributing/code/#step-by-step-from-forking-to-sending-the-pull-request) or convince somebody else to
Review and tidy up contributing documentation.
2014-09-26 09:49:44 +02:00
write it for you. Any "wishlist" type issues without code attached can be
expected to be closed as soon as they're reviewed.
Contribution guidelines, new bugtracker links
2013-04-02 01:46:36 +02:00
</div>
Review and tidy up contributing documentation.
2014-09-26 09:49:44 +02:00
In order to gain interest and feedback in your feature, we encourage you to
Remove module-specific docs instructions We have too many docs to list these out now, even in 3.x this was a bit of a stopgap solution. Point to a centrally managed URL on silverstripe.org instead, where we can update the list of "core modules" regularly without breaking URLs in the docs etc Note that these URLs are also used internally by the Open Sourcerers team.
2018-01-29 03:38:04 +01:00
present it to the community through the [community channels](https://www.silverstripe.org/community).
Contribution guidelines, new bugtracker links
2013-04-02 01:46:36 +02:00
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
DOCS Fixed link on issues and bugs
2015-02-06 08:37:50 +01:00
Report security issues to [security@silverstripe.org](mailto:security@silverstripe.org).
See our "[Release Process](/contributing/release_process/#security-releases)" documentation for more info, and
read our guide on [how to write secure code](/developer_guides/security/secure_coding/).
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
## Sharing your Opinion
DOCS Replaced references to core mailinglist with forum
2018-12-18 22:20:46 +01:00
* [forum.silverstripe.org](http://forum.silverstripe.org): Forums on silverstripe.org
Link to UX issues
2018-02-13 22:14:22 +01:00
* [All issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues)
Reference in New Issue Copy Permalink