silverstripe / silverstripe/developer-docs
Environment set-up guides
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
In order to ensure effective contribution, I think we need to provide some guides on how to set up IDEs / editors for work on SilverStripe core.
Off the top of my head, we should address the following areas:
- editorconfig
- js, php, and css linters
- custom silverstripe syntax packages
And based on https://groups.google.com/forum/#!topic/silverstripe-dev/bozY5hh9g4c, we should cover the following editors:
- PHPStorm
- Sublime Text
- Netbeans
- Atom
This information should probably be put alongside the other handy tips for contribution:
- checking out npm sources
- running js, php tests
- running final linter checks
Some relevant Atom packages
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 existing contribution tips covering checking out npm sources, running JS/PHP tests, and final linter checks. Extend that documentation with setup guidance for EditorConfig, JS/PHP/CSS linters, and SilverStripe syntax packages across PHPStorm, Sublime Text, NetBeans, and Atom; done means each listed area and editor is covered alongside those tips.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, javascript, php
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100