Contenu connexe
Similaire à Submitting a SPSS Extension To the Community (20)
Submitting a SPSS Extension To the Community
- 1. © 2015 IBM Corporation
Submitting a SPSS Extension to the
Community
- 2. © 2015 IBM Corporation2
Why Submit an Extension?
Share with the community
Get featured on the IBM SPSS
Predictive Analytics Gallery
Other community members could
improve or help with your extension
Community Karma – others may
need the extension you built and
you may need theirs
- 3. © 2015 IBM Corporation3
Create GitHub Account
Sign up for account: https://github.com/
Git Familiar with CLI:
− https://try.github.io/levels/1/challenges/1
Mac or Windows users, try the GUI –
− https://desktop.github.com/
- 4. © 2015 IBM Corporation4
Build Repository [Overview]
Main Folder
− Contains README shown on main repo page
− 2 additional files are required to be added to the analytics gallery
Documentation
− Help a user understand the extension and why they should use it
Example
− Give materials needed for a use case of the extension
Screenshot
− Show off the dialog you built and the output
Source Code
− Put the extension and supporting scripts here
- 5. © 2015 IBM Corporation5
Build Repository [Main Folder]
- 6. © 2015 IBM Corporation6
Build Repository [Main Folder]
**Required fields
README.md**
− Markdown file describing
extension
− Include: how to install, R
packages used and additional
dependencies or requirements
− Tip: Try markdown editor
dillinger.io
LICENSE**
− Add Apache Version 2.0
License from GitHub
Default.png**
− 320 x 180 pixel image to be displayed
on the extension gallery
- 7. © 2015 IBM Corporation7
Build Repository [Documentation]
More detailed documentation on extension than exists in the README
Possible items to include:
− Step by step walk through of a use case for the extension
− Detailed explanation of completing dependencies associated with extension
(creating third party account, installing tool, etc.)
− Explanation of dialog for extension
− Explanation of input required for extension
− Explanation of what extension creates for output
- 8. © 2015 IBM Corporation8
Build Repository [Example]
Show a basic or interesting use case for the extension
If applicable:
− Include datasets referenced in documentation
− Include appropriate files needed to recreate the use case.
- 9. © 2015 IBM Corporation9
Build Repository [Screenshot]
Typically include 2-3
screenshots
− Custom Dialog
− Output from extension
− Any other screenshot useful
for demonstration purposes
Tip: Display these screenshots in the
README so a user can see what the
extension looks like on the main repo
page
- 10. © 2015 IBM Corporation10
Build Repository [Source Code]
Add the extension file - .cfe, .spd
Add the source code
− This can just be a copy of the script running in Statistics or Modeler
− Although this can be seen after installing the extension, this is a nice extra
piece to add
- 11. © 2015 IBM Corporation11
Submit Your Extension & Repo
Next Steps:
− Your extension will be lightly tested
and the repository will be reviewed.
− If there are any revisions/questions
you will be contacted via email
− Once approved, your extension will
be forked and added to IBM’s
GitHub
• Submit your extension for review
at the following URL:
https://developer.ibm.com/predictiveanalyt
ics/downloads/#develop
- 12. © 2015 IBM Corporation12
Improve An Existing Extension
If you see an issue with an existing extension or have a suggestion – add it to the
repository on GitHub
Use pull request function of Github to contribute existing extension
Find a bug? Create a issue for the developer on Github
- 13. © 2015 IBM Corporation13
Conclusion
Build your extension
Create a GitHub account
Follow the repository format followed by other extensions
outlined here
Submit your extension for review
Get added to the Analytics Gallery!