DOC Update bug reports page #357
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GuySartorelli
commented
Oct 4, 2023
Comment on lines
-21
to
-23
| * 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/developer-docs/issues) are tracked in the "developer-docs" repository. |
There was a problem hiding this comment.
Which module the issue belongs to moved to the next section
Comment on lines
-25
to
-28
| * The bugtracker is not the place to discuss enhancements, please use | ||
| the ["feature ideas" forum category](https://forum.silverstripe.org/c/feature-ideas) and our [community channels](https://www.silverstripe.org/community). | ||
| 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. |
There was a problem hiding this comment.
No need to put this here, there's a whole section for this further down.
Comment on lines
+11
to
+13
| [alert] | ||
| If you think you've found a security issue, please use [the specific process](#reporting-security-issues) for those. Do _not_ raise a security issue in GitHub. | ||
| [/alert] |
There was a problem hiding this comment.
Make this really prominent to reduce the risk of public security issues
Comment on lines
+62
to
+68
| [warning] | ||
| If you think a bug may have security implications, do not create a GitHub issue for it. This may lead to a zero-day vulnerability. | ||
| [/warning] |
There was a problem hiding this comment.
Make this more prominent in case anyone missed it the first time
Comment on lines
-71
to
-74
| ## Sharing your Opinion | ||
|
|
||
| * [forum.silverstripe.org](http://forum.silverstripe.org): Forums on silverstripe.org | ||
| * [All issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues) |
There was a problem hiding this comment.
This section has no information in it... I don't know what the purpose of it was so I removed it outright.
Comment on lines
-76
to
-86
| ## Identifying issues and pull request relevant to your own project {#identifying-issues} | ||
|
|
||
| Our [issue browser](https://silverstripe-github-issues.now.sh/) can be helpful to identify known issues and pending pull requests in | ||
| [supported modules](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/). | ||
| But you're usually only running some of these modules, and others | ||
| from the [wider module ecosystem](https://addons.silverstripe.org). | ||
|
|
||
| In order to only show issues and pull requests relevant to your project, | ||
| we've written a little [composer utility](https://github.com/silverstripe/silverstripe-github-issue-search-composer-util) | ||
| which inspects your own `composer.lock` file dependencies, | ||
| and searches across all Silverstripe CMS modules in there. |
There was a problem hiding this comment.
This isn't a "how to find bugs that might affect my project" page, and the tool noted here isn't maintained.
There was a problem hiding this comment.
The URLs here for the issue tracker are probably not the best URLs to use. There's a discussion on this in the CMS Squad slack channel, and in the meantime I'll just leave them as is.
GuySartorelli
force-pushed
the
pulls/4.13/contributing-docs1
branch
2 times, most recently
from
89c9169
to
9b979f9
Compare
emteknetnz
requested changes
Oct 11, 2023
| problem can collaborate with you to develop a fix. | ||
| * 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/developer-docs/issues) are tracked in the "developer-docs" repository. | ||
| * Describe the steps required to reproduce your issue, and the expected outcome. Example code, screenshots, and screencasts can help here. |
There was a problem hiding this comment.
Suggested change
| * Describe the steps required to reproduce your issue, and the expected outcome. Example code, screenshots, and screencasts can help here. | |
| * Describe the steps required to reproduce your issue, and the expected outcome. Example code, screenshots, and videos can help here. |
GuySartorelli
force-pushed
the
pulls/4.13/contributing-docs1
branch
from
9b979f9
to
a4305a9
Compare
emteknetnz
approved these changes
Oct 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue