stride3d / stride3d/stride-docs
Script Component type does not have comments explaining what it is
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 39
- Forks
- 74
- Avg merge
- 3h 36m
- Merged PRs (30d)
- 2
Description
Pointed out in Discord by OmniOwl
Okay. Another one here. Writing "Script Component" on the ScriptComponent class as the only thing is not helpful. Should probably explain, or at least point to a URL that shows what a script is in Stride and what is meant by a ScriptComponent.
Because even in the ECS setup, that you seem to at least somewhat follow, that naming convention becomes unclear.
Contributor guide
No contributing guide indexed for this repository
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 locating the ScriptComponent class in the Stride documentation source. Review its current comment and add an explanation of what a script and ScriptComponent mean in Stride, or a URL covering those concepts; done means the comment is no longer just the class name.
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