[docs] Would be good to add an 'A better contribution' page explainging why it is best not to use setUp in PHPunit
Open
Nobody has claimed this yet.
documentation
enhancement
help wanted
needs-triage
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What is the Moodle feature that needs documenting?
I know this is something that @andrewnicols cares about as well as me. setUp in PHPunit is one of those features it is better not to use, but people don't know that, so we should explain. I hope I will get around to this, but I won't mind if someone beats me to it :-)
Is this documentation specific to a Moodle version?
None
Are you able to provide a patch for this?
Yes - I will create one
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
The issue names no file or test; start by locating the developer documentation section for contribution guidance and existing PHPUnit pages. Done means adding an “A better contribution” page that explains why PHPUnit setUp is discouraged, with the guidance applying generally rather than to a specific Moodle version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100