JetBrains / JetBrains/MPS-extensions
Improve startup instructions for novices
Nobody has claimed this yet.
- Dominant language
- JetBrains MPS
- Stars
- 88
- Forks
- 60
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 15
Description
From mps-plaintextgen created by JoostvanPinxten: DSLFoundry/mps-plaintextgen#43
If a user is not so familiair with the MPS generator structure, it can be a challenge to figure out where the right entry points are located.
Describe a very simple start, assuming that the user has no experience with generators. Starting from the root mapping, and showing some of the intentions that make it possible to add fields, and loop over elements in the generator.
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 at the root mapping and trace the generator entry points and intentions mentioned in the issue. Document a simple novice workflow showing how to add fields and loop over elements, then verify that the instructions are understandable without prior generator experience.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100