spockframework / spockframework/spock
Documention not proper for grails spock plugin
Open
Nobody has claimed this yet.
Module-Core
Type-Defect
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 483
- PR merge metrics
- No merged PRs in 30d
Description
Originally reported on Google Code with ID 205
Include appropriate examples and document all the possible ways of using spock.
It's really hard trying to figure out which objects to use and what should be the naming
convention and etc.,
something like: http://grails-plugins.github.com/grails-spring-security-core/docs/manual/
This has already been reported at: http://jira.grails.org/browse/GPSPOCK-8 but seems
like this issue tracker is being used as I see on the plugin page: http://www.grails.org/plugin/spock
Reported by raviteja.lokineni on 2011-09-27 14:46:36
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Grails Spring Security Core manual linked in the issue and the Grails Spock plugin page to identify the expected documentation structure. Document the plugin's usage options, object selection, naming conventions, and representative examples; done means newcomers can understand how to use the plugin without relying on the issue's unanswered questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- groovy, java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100