Contributing to Grails
3 likes654 views
Here are the key points from the document in 3 sentences or less: Contributing to open source projects like Grails can be done in many ways such as submitting pull requests and issues on GitHub, commenting on issues in JIRA, improving documentation, and contributing code changes to the core Grails framework by cloning the GitHub repository and submitting pull requests. The document provides guidance on getting started with contributions through various components of the Grails project and how contributing can help both the project and yourself as a developer through an improved experience and recognition within the community. Contributing is encouraged for anyone interested in helping to further develop Grails.
Contributing to Grails
- 1. Contributing to Grails Peter Ledbrook - VMware t: @pledbrook e: pledbrook@vmware.com © 2012 VMware, Inc. All rights reserved.
- 3. Giving back feels good!
- 4. Expanded Easier on- user base boarding Self interest Improved dev experience
- 5. “Many hands make light work”
- 6. Where to start? 6
- 7. dev@grails.codehaus.org Discuss the direction and future of Grails!
- 8. JIRA • Raise bugs, improvements, new features – Project leads set priority • Vote! – Affects prioritisation • Comment – Make your voice heard • Submit reproducible examples – Preferably with automated tests – These can be incorporated in Grails functional test suite http://jira.grails.org/ 8
- 9. JIRA 9
- 10. JIRA 10
- 11. Reviewing old issues 11
- 12. Reviewing old issues Add recommendation, e.g. close the issue, and why 12
- 13. Want to contribute? Search for Resolution: unresolved, Label: contribute 13
- 14. Useful components in project GRAILS • Documentation • Data binding • URL mappings • View technologies • Persistence • Scaffolding • Request new ones in ADMIN project 14
- 15. Help your fellow man • http://grails.org/doc/latest/ User Guide • https://github.com/grails/grails-doc • http://grails.github.com/grails-howtos/ HOWTOs • https://github.com/grails/grails-howtos 15
- 16. Contributing to documentation • Add missing info • Correct misinformation • Clarify! – Don’t be afraid to rewrite or restructure • Develop HOWTOs – Single page documents • User guide and HOWTOs: – use gdoc wiki syntax – support translations 16
- 17. Contributing to user guide Either pledbrook/grails-doc Sync grails/grails-doc (master) (2.0.x) Push Anyone can ask for commit rights via dev mailing list You 17
- 18. Contributing to user guide Or Pull request <username>/grails-doc grails/grails-doc (patch-n) (<branch>) Push Currently <branch> one of: • master • 2.1.x • 2.0.x You 18
- 19. Contributing to HOWTOs grails/grails-howtos Hudson http://grails.github.com/grails-howtos (master) Push Anyone can ask for commit rights via dev mailing list You 19
- 20. Website (http://grails.org) • Grails application • Used by you! • Currently undergoing facelift • Open source – https://github.com/grails-samples/grails-website • Works with Release plugin – For publishing public plugins • Used for plugin resolution – http://plugins.grails.org/ 20
- 21. Public plugins • Hosted on Grails Central Plugin Repository • Requires permission per plugin to publish – Currently ask on dev mailing list – Website will have plugin submission form – Source code must be available for review • For successful proposal – Correct metadata – Good description – Documentation 21
- 22. Grails core git clone https://github.com/grails/grails-core ./gradlew install export GRAILS_HOME=<path>/grails-core 22
- 23. Grails core UrlMappingsFilter URL mappings GrailsDomainBinder Domain class mapping GrailsDataBinder Data binding GrailsDispatcherServlet Request handling AbstractGrailsPluginManager DefaultGrailsPluginManager Plugin loading and initialisation DefaultGrailsPlugin 23
- 24. Grails core scripts/* Build commands GrailsScriptRunner ‘grails’ command starter grails.build.logging.GrailsConsole InteractiveMode Interactive console 24
- 25. Summary • PaaS is the application platform for the Cloud era • PaaS will change the way you write apps – Design for horizontal scalability – Account for ephemeral file system – Rich set of services – Go polyglot! • Tools & libraries are important – Spring for the win! • Can use Redis in place of RabbitMQ for some patterns 25
- 26. Grails core • Start with pull requests... • ...become a Grails committer! 26
- 27. Summary • Many ways of contributing • Gain kudos, name recognition, etc. • Get a warm fuzzy feeling :) • GitHub, JIRA, website • Learn how to use GitHub: – http://grails.org/screencast/show/21 – or search for GitHub in screencasts 27
- 28. Q&A