Permalink
Browse files

Contribution guidelines, new bugtracker links

  • Loading branch information...
1 parent 1b83e48 commit f5754c11aa22f180f7f5d03c63e72e97f5bd1a3c @chillu chillu committed Apr 1, 2013
View
@@ -23,8 +23,9 @@ If you would like to make changes to the SilverStripe core codebase, we have an
* [Server Requirements](http://doc.silverstripe.org/framework/en/installation/server-requirements)
* [Changelogs](http://doc.silverstripe.org/framework/en/changelogs/)
- * [Framework Bugtracker](https://github.com/silverstripe/sapphire/issues)
- * [CMS Bugtracker](https://github.com/silverstripe/silverstripe-cms/issues)
+ * [Bugtracker: Framework](https://github.com/silverstripe/sapphire/issues)
+ * [Bugtracker: CMS](https://github.com/silverstripe/silverstripe-cms/issues)
+ * [Bugtracker: Installer](https://github.com/silverstripe/silverstripe-installer/issues)
* [Forums](http://silverstripe.org/forums)
* [Developer Mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)
@@ -16,8 +16,4 @@ the language and functions which are used in the guides.
* [Howto customize the CMS menu](customize-cms-menu).
* [How to create a navigation menu](navigation-menu). Create primary navigation for your website.
* [Paginating A List](pagination). Add pagination for an SS_List object.
-* [How to make a simple contact form](simple-contact-form).
-
-## Feedback
-
-If you have a topic you would like covered in these how to's please ask for it on our [Bug Tracker](http://open.silverstripe.org)
+* [How to make a simple contact form](simple-contact-form).
@@ -71,7 +71,7 @@ If you aren't familiar with git and GitHub, try reading the ["GitHub bootcamp do
We also found the [free online git book](http://progit.org/book/) and the [git crash course](http://gitref.org/) useful.
If you're familiar with it, here's the short version of what you need to know. Once you fork and download the code:
- * **Don't develop on the master branch.** Always create a development branch specific to "the issue" you're working on (mostly on [open.silverstripe.org](http://open.silverstripe.org)). Name it by issue number and description. For example, if you're working on Issue #100, a `DataObject::get_one()` bugfix, your development branch should be called 100-dataobject-get-one. If you decide to work on another issue mid-stream, create a new branch for that issue--don't work on both in one branch.
+ * **Don't develop on the master branch.** Always create a development branch specific to "the issue" you're working on (mostly on our [bugtracker](/misc/contributing/issues)). Name it by issue number and description. For example, if you're working on Issue #100, a `DataObject::get_one()` bugfix, your development branch should be called 100-dataobject-get-one. If you decide to work on another issue mid-stream, create a new branch for that issue--don't work on both in one branch.
* **Do not merge the upstream master** with your development branch; *rebase* your branch on top of the upstream master.
@@ -6,12 +6,16 @@
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!
-Our bugtracker is located on [open.silverstripe.org](http://open.silverstripe.org/).
+
+ * [Framework Bugtracker](https://github.com/silverstripe/sapphire/issues)
+ * [CMS Bugtracker](https://github.com/silverstripe/silverstripe-cms/issues)
+ * [Documentation Bugtracker](https://github.com/silverstripe/sapphire/issues)
+ * Search on [http://silverstripe.org/modules](http://silverstripe.org/modules) for module-specific bugtrackers
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
+ * Search for similar, existing tickets
* 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?
@@ -21,12 +25,28 @@ Before submitting a bug:
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.
+ * [Create a new ticket](https://github.com/silverstripe/sapphire/issues/new)
+ * 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.
- * 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.
+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
+
+<div class="warning" markdown='1'>
+Please don't file "feature requests" as 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](/misc/contributing/code))
+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.
+</div>
+
+In order to gain interest and feedback in your feature, we encourage you to present
+it to the community through the [forums](http://silverstripe.org/forums), [core mailinglist](http://groups.google.com/group/silverstripe-dev) or on [IRC](http://silverstripe.org/irc).
+
## 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).
@@ -7,9 +7,4 @@ sections.
* [Contributing](contributing): How you can be a part of the SilverStripe Open Source community
* [Module release process](module-release-process): Creating and looking after a module
* [Release process](release-process): Describes the Framework and CMS release process
-* [SS markdown](ss-markdown): Markdown syntax for our technical documentation
-
-## Feedback
-
-If you have a topic you would like covered in the misc section please ask for it on our [Bug Tracker](http://open.silverstripe.org)
-
+* [SS markdown](ss-markdown): Markdown syntax for our technical documentation
@@ -52,7 +52,7 @@ your modules page on silverstripe.org
Both Google Code and github.com provide their own bugtracker - we encourage you to use any built-in tools that come with
your version control hoster. Most Silverstripe-maintained modules have their bugtracker on
-[open.silverstripe.org](http://open.silverstripe.org).
+[github.com](http://www.github.com) (see [issue reporting guidelines](/misc/contributing/issues)).
Providing bugtracking is a major form of communicating with your users in an efficient way, and will provide a good overview
of outstanding work and the stability of your code to an interested user.
@@ -111,7 +111,7 @@ that you can link from the `README.md` file. Example:
tutorial.md
howto-search-mymodule.md
-The ["docsviewer" module](http://open.silverstripe.org/browser/modules/docsviewer/trunk) can be used
+The ["docsviewer" module](https://github.com/silverstripe/silverstripe-docsviewer) can be used
to list and render content inside a `docs/` folder (although it is not required, Markdown is designed
to be readable in plain text as well).
@@ -120,7 +120,6 @@ to be readable in plain text as well).
In return for all your hard work in putting a high-quality module on the site, the SilverStripe project has the following
options to support you:
-* Use of [trac](http://open.silverstripe.org) to keep your bugs and feature requests organised
* Advertising of your module on the http://silverstripe.org/modules/ modules page once it has reached a beta stage and shown
to meet our requirements above.
* We might showcase your module on our blog and/or newsletter, when it's first released and/or when a major version with
@@ -9,13 +9,13 @@ The current maintainer responsible for planning and performing releases is Ingo
## Release Planning
-Our most up-to-date release plans are typically in the [roadmap](http://open.silverstripe.com/roadmap).
+Our most up-to-date release plans are typically in the ["framework" milestone](https://github.com/silverstripe/sapphire/issues/milestones) and ["cms" milestone](https://github.com/silverstripe/silverstripe-cms/issues/milestones).
New features and API changes are typically discussed on the [core
mailinglist](http://groups.google.com/group/silverstripe-dev). They are prioritized by the core team as tickets on
-[open.silverstripe.org](http://open.silverstripe.com/).
+github.com.
Release dates are usually not published prior to the release, but you can get a good idea of the release status by
-reviewing the [release milestone](http://open.silverstripe.com/roadmap) on open.silverstripe.org. 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).
Releases of the *cms* and *framework* modules are coupled at the moment, they follow the same numbering scheme. Module
@@ -124,8 +124,8 @@ released version (e.g. 3.1.1), the target version becomes 3.2 instead.
### Reporting an issue
-Report security issues to [security@silverstripe.com](mailto:security@silverstripe.com). Please don't file security
-issues in our [bugtracker](http://open.silverstripe.org).
+Report security issues to [security@silverstripe.com](mailto:security@silverstripe.com).
+Please don't file security issues in our [bugtracker](/misc/contributing/issues).
### Acknowledgement and disclosure
@@ -647,5 +647,4 @@ afraid to experiment with using other approaches.
* [css](css)
* [Unobtrusive Javascript](http://www.onlinetools.org/articles/unobtrusivejavascript/chapter1.html)
-* [Quirksmode: In-depth Javascript Resources](http://www.quirksmode.org/resources.html)
-* [behaviour.js documentation](http://open.silverstripe.org/browser/modules/sapphire/branches/2.4/thirdparty/behaviour/README.md)
+* [Quirksmode: In-depth Javascript Resources](http://www.quirksmode.org/resources.html)

0 comments on commit f5754c1

Please sign in to comment.