OSS-905 Moved contributions of Widgets to contributing.md
This commit is contained in:
parent
a586a034d1
commit
6136b4f1ea
|
@ -1,3 +1,41 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
Contributions are welcome! Create an issue, explaining a bug or proposal. Submit pull requests if you feel brave. Speak to me on [Twitter](https://twitter.com/assertchris).
|
Contributions are welcome! Create an issue, explaining a bug or proposal. Submit pull requests if you feel brave. Speak to me on [Twitter](https://twitter.com/assertchris).
|
||||||
|
|
||||||
|
## Releasing a widget
|
||||||
|
|
||||||
|
Follow the [standard procedures defined for releasing a SilverStripe module](http://doc.silverstripe.org/framework/en/3.1/topics/module-development).
|
||||||
|
|
||||||
|
Here is a composer template you can use.
|
||||||
|
|
||||||
|
You need to finish off / change:
|
||||||
|
|
||||||
|
* name (eg: `yourorganisation/silverstripe-widget-carousel`)
|
||||||
|
* description
|
||||||
|
* keywords
|
||||||
|
* license
|
||||||
|
* author
|
||||||
|
* installer-name (eg: `widgets_carousel`)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "",
|
||||||
|
"type": "silverstripe-module",
|
||||||
|
"keywords" : ["widget"],
|
||||||
|
"require": {
|
||||||
|
"silverstripe/framework": "3.*",
|
||||||
|
"silverstripe/cms": "3.*"
|
||||||
|
},
|
||||||
|
"license": "BSD-2-Clause",
|
||||||
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"email": ""
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"extra" : {
|
||||||
|
"installer-name": "widgets_"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
Loading…
Reference in New Issue