tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-09-29 04:39:01 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #7809 from open-sausages/pulls/4/docs-module-list

Browse Source 
Remove module-specific docs instructions
This commit is contained in:
Robbie Averill 2018-01-30 10:13:18 +13:00 committed by GitHub
commit dac247b58d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 29 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/en/05_Contributing/00_Issues_and_Bugs.md
View File

@ -8,26 +8,25 @@ summary: Report bugs or problems with SilverStripe, feature requests or other is
If you have discovered a bug in SilverStripe, we'd be glad to hear about it - 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! well written bug reports can be half of the solution already!
* [Framework Bugtracker](https://github.com/silverstripe/silverstripe-framework/issues)
* [CMS Bugtracker](https://github.com/silverstripe/silverstripe-cms/issues)
* [Documentation Bugtracker](https://github.com/silverstripe/silverstripe-framework/issues)
* Search on [http://addons.silverstripe.org/](http://addons.silverstripe.org/) for module-specific bugtrackers
* Request features: [UserVoice](http://silverstripe.uservoice.com).
Before submitting a bug: Before submitting a bug:
* Ask for assistance on the [forums](http://www.silverstripe.org/community/forums/), [core mailinglist](http://groups.google.com/group/silverstripe-dev) or on [IRC](http://irc.silverstripe.org/) if you're unsure if its really a bug. * 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 * Search for similar, existing tickets.
You can [list all issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues),
then add your search phrase at the start of the existing search filters.
* Is this a security issue? Please follow our separate reporting guidelines below. * 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 [http://addons.silverstripe.org/](http://addons.silverstripe.org/)) * 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.
* 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? * 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?
* The bugtracker is not the place to discuss enhancements, please use the forums or mailinglist. * The bugtracker is not the place to discuss enhancements, please use
[UserVoice](http://silverstripe.uservoice.com) and our [community channels](https://www.silverstripe.org/community).
Only log enhancement tickets if they gather a large interest in the 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. and the enhancement is likely to be implemented in the next couple of months.
If the issue does look like a new bug: If the issue does look like a new bug:
* [Create a new ticket](https://github.com/silverstripe/silverstripe-framework/issues/new) * 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 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. * Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.
* *(optional)* [Submit a pull request](/contributing/code/#step-by-step-from-forking-to-sending-the-pull-request) which fixes the issue. * *(optional)* [Submit a pull request](/contributing/code/#step-by-step-from-forking-to-sending-the-pull-request) which fixes the issue.
@ -48,9 +47,7 @@ expected to be closed as soon as they're reviewed.
</div> </div>
In order to gain interest and feedback in your feature, we encourage you to In order to gain interest and feedback in your feature, we encourage you to
present it to the community through the [forums](http://www.silverstripe.org/community/forums), present it to the community through the [community channels](https://www.silverstripe.org/community).
[core mailinglist](http://groups.google.com/group/silverstripe-dev) or on
[IRC](http://irc.silverstripe.org/).
## Reporting Security Issues ## Reporting Security Issues
@ -62,4 +59,4 @@ read our guide on [how to write secure code](/developer_guides/security/secure_c
* [silverstripe.org/forums](http://www.silverstripe.org/community/forums/): Forums on silverstripe.org * [silverstripe.org/forums](http://www.silverstripe.org/community/forums/): Forums on silverstripe.org
* [silverstripe-dev](http://groups.google.com/group/silverstripe-dev/): Core development mailinglist * [silverstripe-dev](http://groups.google.com/group/silverstripe-dev/): Core development mailinglist
* [silverstripe-documentation](http://groups.google.com/group/silverstripe-documentation/): Documentation mailing list * [All issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues)

2
docs/en/05_Contributing/01_Code.md
View File

@ -205,7 +205,7 @@ Same goes for version control plumbing like merges, file renames or reverts.
Further guidelines: Further guidelines:
* Each commit should form a logical unit - if you fix two unrelated bugs, commit each one separately * Each commit should form a logical unit - if you fix two unrelated bugs, commit each one separately
* If you are fixing a issue from our bugtracker ([cms](https://github.com/silverstripe/silverstripe-framework) and [framework](https://github.com/silverstripe/silverstripe-framework)), please append `(fixes #<ticketnumber>)` * If you are fixing a issue from our bugtracker (see [Reporting Bugs](issues_and_bugs)), please append `(fixes #<ticketnumber>)`
* When fixing issues across repos (e.g. a commit to `framework` fixes an issue raised in the `cms` bugtracker), * When fixing issues across repos (e.g. a commit to `framework` fixes an issue raised in the `cms` bugtracker),
use `(fixes silverstripe/silverstripe-cms#<issue-number>)` ([details](https://github.com/blog/1439-closing-issues-across-repositories)) use `(fixes silverstripe/silverstripe-cms#<issue-number>)` ([details](https://github.com/blog/1439-closing-issues-across-repositories))
* If your change is related to another commit, reference it with its abbreviated commit hash. * If your change is related to another commit, reference it with its abbreviated commit hash.

20
docs/en/05_Contributing/04_Release_Process.md
View File

@ -6,7 +6,13 @@ This page describes the process followed for "core" releases (mainly the `framew
## Release Planning ## Release Planning
Our most up-to-date release plans are typically in the ["framework" milestone](https://github.com/silverstripe/silverstripe-framework/milestones) and ["cms" milestone](https://github.com/silverstripe/silverstripe-cms/milestones). Releases are planned by assigning issues to GitHub milestones.
SilverStripe is split up into many modules listed on [github.com/silverstripe](https://github.com/silverstripe).
Each of them will have its own milestones and issues, and different release lines (e.g. 1.x vs. 4.x).
There are high-level "recipe" milestones on the [framework repository](https://github.com/silverstripe/silverstripe-framework/milestones)
to combine individual module milestones into a larger release that's eventually available on
[silverstripe.org/download](https://silverstripe.org/download).
New features and API changes are discussed on the [core mailinglist](http://groups.google.com/group/silverstripe-dev). They are prioritised by the core team as tickets on New features and API changes are discussed on the [core mailinglist](http://groups.google.com/group/silverstripe-dev). They are prioritised by the core team as tickets on
github.com. In addition, we collect community feedback on [silverstripe.uservoice.com](https://silverstripe.uservoice.com). github.com. In addition, we collect community feedback on [silverstripe.uservoice.com](https://silverstripe.uservoice.com).
Any feature ideas we're planning to implement will be flagged there. Any feature ideas we're planning to implement will be flagged there.
@ -15,8 +21,6 @@ Release dates are usually not published prior to the release, but you can get a
reviewing the release milestone on github.com. Releases will be reviewing the release milestone on github.com. Releases will be
announced on the [release announcements mailing list](http://groups.google.com/group/silverstripe-announce). announced on the [release announcements mailing list](http://groups.google.com/group/silverstripe-announce).
Releases of the *cms* and *framework* modules are coupled at the moment, and they follow the same numbering scheme.
## Release Numbering ## Release Numbering
SilverStripe follows [Semantic Versioning](http://semver.org). SilverStripe follows [Semantic Versioning](http://semver.org).
@ -185,12 +189,10 @@ Please contact security@silverstripe.org for details.
The quality of our software is important to us, and we continously test it for regressions The quality of our software is important to us, and we continously test it for regressions
through a broad suite of unit and integration tests. Most of these run on through a broad suite of unit and integration tests. Most of these run on
[Travis CI](http://travis-ci.com), and results are publicly available [Travis CI](http://travis-ci.com), and results are publicly available.
for the [framework](https://travis-ci.org/silverstripe/silverstripe-framework) and Check the badges on the various modules available on [github.com/silverstripe](http://github.com/silverstripe).
[cms](https://travis-ci.org/silverstripe/silverstripe-cms) modules. There's also a [build matrix](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
In addition, some build configurations (e.g. running on Windows) are tested for our commercially supported modules (only showing build status for the default branch).
through a [TeamCity](http://www.jetbrains.com/teamcity/) instance hosted at
[teamcity.silverstripe.com](http://teamcity.silverstripe.com) (click "Login as guest").
## Releasing to modules to NPM ## Releasing to modules to NPM

12
docs/en/05_Contributing/05_Making_A_SilverStripe_Core_Release.md
View File

@ -156,10 +156,9 @@ cross-posted to other relevant channels such as Twitter and Facebook.
Sending an email to [marketing@silverstripe.com](mailto:marketing@silverstripe.com) Sending an email to [marketing@silverstripe.com](mailto:marketing@silverstripe.com)
with an overview of the release and a rough release timeline. with an overview of the release and a rough release timeline.
Check all tickets ([framework](https://github.com/silverstripe/silverstripe-framework/milestones), Check all tickets assigned to that milestone are either closed or reassigned to another milestone.
[cms](https://github.com/silverstripe/silverstripe-cms/milestones), Use the [list of all issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues)
[installer](https://github.com/silverstripe/silverstripe-installer/milestones)) assigned to that milestone are as a starting point, and add a `milestone:"your-milestone"` filter.
either closed or reassigned to another milestone.
Merge up from other older supported release branches (e.g. merge `3.1`->`3.2`, `3.2`->`3.3`, `3.3`->`3`, `3`->`master`). Merge up from other older supported release branches (e.g. merge `3.1`->`3.2`, `3.2`->`3.3`, `3.3`->`3`, `3`->`master`).
@ -214,9 +213,8 @@ by running it locally (e.g. `http://localhost/release-3.3.4`) to do some smoke-t
and make sure that there are no obvious issues missed. and make sure that there are no obvious issues missed.
Since `cow` will only run the unit test suite, you'll need to check Since `cow` will only run the unit test suite, you'll need to check
the build status of Behat end-to-end tests manually on travis-ci.org the build status of Behat end-to-end tests manually on travis-ci.org.
for the various modules (e.g. [framework](https://travis-ci.org/silverstripe/silverstripe-framework)) Check the badges on the various modules available on [github.com/silverstripe](http://github.com/silverstripe).
and [cms](https://travis-ci.org/silverstripe/silverstripe-cms)).
It's also ideal to eyeball the git changes generated by the release tool, making sure It's also ideal to eyeball the git changes generated by the release tool, making sure
that no translation strings were unintentionally lost, no malicious changes were that no translation strings were unintentionally lost, no malicious changes were