silverstripe / silverstripe/developer-docs
Docs for how to create a module with composer
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
https://docs.silverstripe.org/en/4/developer_guides/extending/modules/ and https://docs.silverstripe.org/en/4/developer_guides/extending/how_tos/publish_a_module/ don't describe how to actually create a module. With composer, there's a bit of a chicken-and-egg situation: You need to have a module to install it via composer on your site, get autoloading going, and then start developing.
Given that we want people to create modules for SilverStripe, this should be far more obvious.
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 with the two linked SilverStripe documentation pages, focusing on their existing module and publishing guidance. Document the missing Composer-based creation workflow, including how a new module can be set up before installing it in a site; done means a newcomer can follow the instructions to begin module development.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100